XII Release 0.1.0
Loading...
Searching...
No Matches
xiiGALPipelineResourceDescription Struct Reference

This describes the pipeline resource information. More...

#include <PipelineResourceSignature.h>

Inheritance diagram for xiiGALPipelineResourceDescription:
[legend]

Public Member Functions

 XII_DECLARE_POD_TYPE ()
 
- Public Member Functions inherited from xiiHashableStruct< xiiGALPipelineResourceDescription >
constexpr xiiHashableStruct () noexcept
 Default constructor. Initializes all bytes to zero.
 
 xiiHashableStruct (const xiiHashableStruct &other) noexcept
 Bitwise copy constructor.
 
xiiHashableStructoperator= (const xiiHashableStruct &other) noexcept
 Bitwise assignment operator.
 
bool operator== (const xiiHashableStruct &other) const noexcept
 Compares equality via raw byte comparison.
 
std::strong_ordering operator<=> (const xiiHashableStruct &other) const noexcept
 Compares ordering via raw byte comparison.
 
xiiUInt32 CalculateHash () const noexcept
 Calculates a 32-bit hash from raw bytes of the struct.
 
void Clear () noexcept
 Fills all bytes with zero.
 
bool IsZero () const noexcept
 Returns true if all bytes are zero.
 

Public Attributes

xiiHashedString m_sName
 The resource name in the shader.
 
xiiBitflags< xiiGALShaderTypem_ShaderStages = xiiGALShaderType::Unknown
 
xiiUInt32 m_uiArraySize = 0U
 The resource array size (must be set to 1 for non-array resources). The default is 0.
 
xiiUInt32 m_uiBindSet = 0U
 The resource bind set, for descriptor sets.
 
xiiUInt32 m_uiBindSlot = 0U
 The resource bind slot in the bind set.
 
xiiEnum< xiiGALShaderResourceTypem_ResourceType = xiiGALShaderResourceType::Unknown
 The resource type, see xiiGALShaderResourceType. The default is xiiGALShaderResourceType::Unknown.
 
xiiBitflags< xiiGALPipelineResourceFlagsm_PipelineResourceFlags = xiiGALPipelineResourceFlags::None
 Special resource flags, see xiiGALPipelineResourceFlags. The default is xiiGALPipelineResourceFlags::None.
 

Detailed Description

This describes the pipeline resource information.

Member Data Documentation

◆ m_ShaderStages

xiiBitflags<xiiGALShaderType> xiiGALPipelineResourceDescription::m_ShaderStages = xiiGALShaderType::Unknown

The shader stages that this resource applies to. When multiple shader stages are specified, all stages will share the same resource. The default is xiiGALShaderType::Unknown.

                                         \remarks There may be multiple resources with the same name in different shader stages, but the stages specified for different resources with the same name must not overlap. 

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