Diligent::IShaderResourceVariable struct

Shader resource variable.

Base classes

struct IObject
Base interface for all dynamic objects in the engine.

Derived classes

class IShaderResourceVariableD3D
Interface to the Direct3D ShaderResourceVariable resource variable.
template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>
struct ShaderVariableBase
Base implementation of a shader variable.
template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>
struct ShaderVariableBase
Base implementation of a shader variable.
template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>
struct ShaderVariableBase
Base implementation of a shader variable.
template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>
struct ShaderVariableBase
Base implementation of a shader variable.
template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>
struct ShaderVariableBase
Base implementation of a shader variable.
template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>
struct ShaderVariableBase
Base implementation of a shader variable.
template<typename ThisImplType, typename VarManagerType, typename ResourceVariableBaseInterface = IShaderResourceVariable>
struct ShaderVariableBase
Base implementation of a shader variable.

Public functions

auto Set(IDeviceObject* pObject) -> void METHOD() virtual
Binds resource to the variable.
auto SetArray(IDeviceObject*const* ppObjects, Uint32 FirstElement, Uint32 NumElements) -> void METHOD() virtual
Binds resource array to the variable.
auto GetType() const -> SHADER_RESOURCE_VARIABLE_TYPE METHOD() virtual
Returns the shader resource variable type.
auto GetResourceDesc(ShaderResourceDesc& ResourceDesc) const -> void METHOD() virtual
Returns shader resource description. See Diligent::ShaderResourceDesc.
auto GetIndex() const -> Uint32 METHOD() virtual
Returns the variable index that can be used to access the variable.
auto IsBound(Uint32 ArrayIndex) const -> bool METHOD() virtual
Returns true if non-null resource is bound to this variable.

Function documentation

void METHOD() Diligent::IShaderResourceVariable::Set(IDeviceObject* pObject) virtual

Binds resource to the variable.

void METHOD() Diligent::IShaderResourceVariable::SetArray(IDeviceObject*const* ppObjects, Uint32 FirstElement, Uint32 NumElements) virtual

Binds resource array to the variable.

Parameters
ppObjects in - pointer to the array of objects
FirstElement in - first array element to set
NumElements in - number of objects in ppObjects array

bool METHOD() Diligent::IShaderResourceVariable::IsBound(Uint32 ArrayIndex) const virtual

Returns true if non-null resource is bound to this variable.

Parameters
ArrayIndex in - Resource array index. Must be 0 for non-array variables.