xiiGALDrawIndexedDescription Struct Reference

Describes parameters for issuing indexed draw calls. More...

#include <CommandList.h>

Public Member Functions
	XII_DECLARE_POD_TYPE ()
XII_ALWAYS_INLINE	xiiGALDrawIndexedDescription ()=default
	Default-initialized indexed draw description (0 indices, 1 instance).
XII_ALWAYS_INLINE	xiiGALDrawIndexedDescription (xiiUInt32 uiIndexCount, xiiEnum< xiiGALValueType > IndexType, xiiUInt32 uiInstanceCount=1U, xiiUInt32 uiFirstIndexLocation=0U, xiiUInt32 uiBaseVertex=0U, xiiUInt32 uiFirstInstanceLocation=0U)
	Constructs an indexed draw description with specified parameters.

Public Attributes
xiiUInt32	m_uiIndexCount = 0U
	Number of indices to process.
xiiEnum< xiiGALValueType >	m_IndexType = xiiGALValueType::Undefined
	Type of index data.
xiiUInt32	m_uiInstanceCount = 1U
	Number of instances to render.
xiiUInt32	m_uiFirstIndexLocation = 0U
	Offset into the index buffer to start reading from.
xiiUInt32	m_uiBaseVertex = 0U
	Value added to each index before fetching from the vertex buffer.
xiiUInt32	m_uiFirstInstanceLocation = 0U
	First instance ID passed to the vertex shader.

Detailed Description

Describes parameters for issuing indexed draw calls.

Defines the index and instance counts, index type, and offsets required for issuing GPU draw calls using an index buffer. Used in graphics command encoding for geometry instancing and reuse.

See also

xiiGALCommandList::DrawIndexed

Constructor & Destructor Documentation

xiiGALDrawIndexedDescription()

XII_ALWAYS_INLINE xiiGALDrawIndexedDescription::xiiGALDrawIndexedDescription ( xiiUInt32 uiIndexCount, xiiEnum< xiiGALValueType > IndexType, xiiUInt32 uiInstanceCount = 1U, xiiUInt32 uiFirstIndexLocation = 0U, xiiUInt32 uiBaseVertex = 0U, xiiUInt32 uiFirstInstanceLocation = 0U )

inline

Constructs an indexed draw description with specified parameters.

Parameters

uiIndexCount	- Number of indices to process.
IndexType	- Type of index data (e.g., 16-bit or 32-bit unsigned int).
uiInstanceCount	- Number of instances to render. Defaults to 1.
uiFirstIndexLocation	- Offset into the index buffer to start reading from.
uiBaseVertex	- Value added to each index before fetching from the vertex buffer.
uiFirstInstanceLocation	- First instance ID passed to the vertex shader.

---

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

• /home/runner/work/XII/XII/Source/Engine/GraphicsFoundation/CommandEncoder/CommandList.h