xiiGALDrawDescription Struct Reference

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

#include <CommandList.h>

Public Member Functions
	XII_DECLARE_POD_TYPE ()
XII_ALWAYS_INLINE	xiiGALDrawDescription ()=default
	Default-initialized draw description (0 vertices, 1 instance).
XII_ALWAYS_INLINE	xiiGALDrawDescription (xiiUInt32 uiVertexCount, xiiUInt32 uiInstanceCount=1U, xiiUInt32 uiStartVertexLocation=0U, xiiUInt32 uiFirstInstanceLocation=0U)
	Constructs a draw description with specified parameters.

Public Attributes
xiiUInt32	m_uiVertexCount = 0U
	Number of vertices to process.
xiiUInt32	m_uiInstanceCount = 1U
	Number of instances to render.
xiiUInt32	m_uiStartVertexLocation = 0U
	Start vertex offset within the bound vertex buffer.
xiiUInt32	m_uiFirstInstanceLocation = 0U
	First instance ID passed to vertex shader.

Detailed Description

Describes parameters for issuing non-indexed draw calls.

Defines the vertex and instance counts, as well as starting locations, for issuing a basic GPU draw call. Used in graphics command encoding where geometry is streamed directly from vertex buffers.

See also

xiiGALCommandList::Draw

Constructor & Destructor Documentation

xiiGALDrawDescription()

XII_ALWAYS_INLINE xiiGALDrawDescription::xiiGALDrawDescription ( xiiUInt32 uiVertexCount, xiiUInt32 uiInstanceCount = 1U, xiiUInt32 uiStartVertexLocation = 0U, xiiUInt32 uiFirstInstanceLocation = 0U )

inline

Constructs a draw description with specified parameters.

Parameters

uiVertexCount	- Number of vertices to draw.
uiInstanceCount	- Number of instances to render. Defaults to 1.
uiStartVertexLocation	- Index of the first vertex to read.
uiFirstInstanceLocation	- Instance ID for the first instance.

---

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

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