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

This describes a single element in the input layout. More...

#include <InputLayout.h>

Inheritance diagram for xiiGALLayoutElement:
[legend]

Public Member Functions

 XII_DECLARE_POD_TYPE ()
 
- Public Member Functions inherited from xiiHashableStruct< xiiGALLayoutElement >
 xiiHashableStruct (const xiiHashableStruct< xiiGALLayoutElement > &other)
 
void operator= (const xiiHashableStruct< xiiGALLayoutElement > &other)
 
XII_ALWAYS_INLINE constexpr bool operator== (const xiiHashableStruct< xiiGALLayoutElement > &rhs) const=default
 
xiiUInt32 CalculateHash () const
 Calculates the 32 bit hash of the struct and returns it.
 

Public Attributes

xiiEnum< xiiGALInputLayoutSemanticm_Semantic = xiiGALInputLayoutSemantic::Undefined
 The element semantic. The default is Undefined.
 
xiiUInt32 m_uiInputIndex = 0U
 The input index of the element specified in the vertex shader. The default is 0.
 
xiiUInt32 m_uiBufferSlot = 0U
 The buffer slot index that this element is read from. The default is 0.
 
xiiEnum< xiiGALResourceFormatm_Format = xiiGALResourceFormat::Unknown
 The element format. The default is xiiGALResourceFormat::Unknown.
 
xiiUInt32 m_uiRelativeOffset = XII_GAL_LAYOUT_ELEMENT_AUTO_OFFSET
 The relative offset to the element in bytes. If this value is set to XII_GAL_LAYOUT_ELEMENT_AUTO_OFFSET (default value), the offset will be computed automatically by placing the element right after the previous one.
 
xiiUInt32 m_uiStride = XII_GAL_LAYOUT_ELEMENT_AUTO_STRIDE
 The stride in bytes between two elements for this buffer slot. If this value is is set to XII_GAL_LAYOUT_ELEMENT_AUTO_STRIDE (default value), the stride will be computed automatically assuming that all elements in the same buffer are packed contiguously. If the buffer slot contains multiple layout elements, they all must specify the same stride or use the XII_GAL_LAYOUT_ELEMENT_AUTO_OFFSET value.
 
xiiEnum< xiiGALInputElementFrequencym_Frequency = xiiGALInputElementFrequency::PerVertex
 The element frequency. The default is xiiGALInputElementFrequency::PerVertex.
 
xiiUInt32 m_uiInstanceDataStepRate = 1U
 The number of instances to draw using the same per-instance data before advancing in the buffer by one element. The default is 1.
 

Detailed Description

This describes a single element in the input layout.


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