Torque3D Documentation / _generateds / GFXShaderConstHandle

GFXShaderConstHandle

Engine/source/gfx/gfxShader.h

This is an opaque handle used by GFXShaderConstBuffer clients to set individual shader constants.

More...

Protected Attributes

bool

mValid

The state of the constant which is set from the derived class.

Public Functions

GFXShaderConstHandle()

~GFXShaderConstHandle()

U32

getArraySize()

const String &

getName()

Returns the name of the constant handle.
S32

getSamplerRegister()

Returns -1 if this handle does not point to a Sampler.
GFXShaderConstType

getType()

Returns the type of the constant handle.
bool

isValid()

Returns true if this constant is valid and can be set on the shader.
Detailed Description
This is an opaque handle used by GFXShaderConstBuffer clients to set individual shader constants.
Derived classes can put whatever info they need into here, these handles are owned by the shader constant buffer (or shader). Client code should not free these.
Protected Attributes
bool mValid 

The state of the constant which is set from the derived class.
Public Functions
GFXShaderConstHandle()

~GFXShaderConstHandle()

getArraySize()

Reimplemented by: GFXD3D11ShaderConstHandle, GFXGLShaderConstHandle
getName()

Returns the name of the constant handle.
Reimplemented by: GFXD3D11ShaderConstHandle, GFXGLShaderConstHandle
getSamplerRegister()

Returns -1 if this handle does not point to a Sampler.
Reimplemented by: GFXD3D11ShaderConstHandle, GFXGLShaderConstHandle
getType()

Returns the type of the constant handle.
Reimplemented by: GFXD3D11ShaderConstHandle, GFXGLShaderConstHandle
isValid()

Returns true if this constant is valid and can be set on the shader.