Represents a graphics platform independent GPU sampler resource that perform texture sampling operations.
More...
#include <sampler.h>
|
| HGI_API HgiSamplerDesc const & | GetDescriptor () const |
| | The descriptor describes the object.
|
| |
| virtual HGI_API uint64_t | GetRawResource () const =0 |
| | This function returns the handle to the Hgi backend's gpu resource, cast to a uint64_t.
|
| |
Represents a graphics platform independent GPU sampler resource that perform texture sampling operations.
Samplers should be created via Hgi::CreateSampler.
Definition at line 108 of file sampler.h.
◆ GetDescriptor()
The descriptor describes the object.
◆ GetRawResource()
| virtual HGI_API uint64_t GetRawResource |
( |
| ) |
const |
|
pure virtual |
This function returns the handle to the Hgi backend's gpu resource, cast to a uint64_t.
Clients should avoid using this function and instead use Hgi base classes so that client code works with any Hgi platform. For transitioning code to Hgi, it can however we useful to directly access a platform's internal resource handles. There is no safety provided in using this. If you by accident pass a HgiMetal resource into an OpenGL call, bad things may happen. In OpenGL this returns the GLuint resource name. In Metal this returns the id<MTLSamplerState> as uint64_t. In Vulkan this returns the VkSampler as uint64_t.
Implemented in HgiGLSampler.
◆ _descriptor
The documentation for this class was generated from the following file:
Inheritance diagram for HgiSampler:
1.9.6 