All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HgiGLShaderFunction Class Referencefinal

#include <shaderFunction.h>

+ Inheritance diagram for HgiGLShaderFunction:

Public Member Functions

HGIGL_API ~HgiGLShaderFunction () override
HGIGL_API bool IsValid () const override
 Returns false if any shader compile errors occured. More...
HGIGL_API std::string constGetCompileErrors () override
 Returns shader compile errors. More...
HGIGL_API size_t GetByteSizeOfResource () const override
HGIGL_API uint64_t GetRawResource () const override
HGIGL_API uint32_t GetShaderId () const
 Returns the gl resource id of the shader. More...
- Public Member Functions inherited from HgiShaderFunction
virtual HGI_API ~HgiShaderFunction ()
HGI_API HgiShaderFunctionDesc
GetDescriptor () const
 The descriptor describes the object. More...

Protected Member Functions

HGIGL_API HgiGLShaderFunction (HgiShaderFunctionDesc const &desc)
- Protected Member Functions inherited from HgiShaderFunction
HGI_API HgiShaderFunction (HgiShaderFunctionDesc const &desc)


class HgiGL

Additional Inherited Members

- Protected Attributes inherited from HgiShaderFunction
HgiShaderFunctionDesc _descriptor

Detailed Description

OpenGL implementation of HgiShaderFunction

Definition at line 39 of file shaderFunction.h.

Constructor & Destructor Documentation

HGIGL_API HgiGLShaderFunction::~HgiGLShaderFunction ( )
HGIGL_API HgiGLShaderFunction::HgiGLShaderFunction ( HgiShaderFunctionDesc const desc)

Member Function Documentation

HGIGL_API size_t HgiGLShaderFunction::GetByteSizeOfResource ( ) const

Returns the byte size of the GPU shader function. This can be helpful if the application wishes to tally up memory usage.

Implements HgiShaderFunction.

HGIGL_API std::string const& HgiGLShaderFunction::GetCompileErrors ( )

Returns shader compile errors.

Implements HgiShaderFunction.

HGIGL_API uint64_t HgiGLShaderFunction::GetRawResource ( ) const

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<MTLFunction> as uint64_t. In Vulkan this returns the VkShaderModule as uint64_t. In DX12 this returns the ID3D12Resource pointer as uint64_t.

Implements HgiShaderFunction.

HGIGL_API uint32_t HgiGLShaderFunction::GetShaderId ( ) const

Returns the gl resource id of the shader.

HGIGL_API bool HgiGLShaderFunction::IsValid ( ) const

Returns false if any shader compile errors occured.

Implements HgiShaderFunction.

Friends And Related Function Documentation

friend class HgiGL

Definition at line 62 of file shaderFunction.h.

The documentation for this class was generated from the following file: