xiiGALDispatchComputeDescription Struct Reference

Describes parameters for issuing a compute dispatch call. More...

#include <CommandList.h>

Public Member Functions
XII_ALWAYS_INLINE	xiiGALDispatchComputeDescription ()=default
	Default-initialized compute dispatch (1 group in each dimension).
XII_ALWAYS_INLINE	xiiGALDispatchComputeDescription (xiiUInt32 uiGroupCountX, xiiUInt32 uiGroupCountY, xiiUInt32 uiGroupCountZ=1U)
	Constructs a compute dispatch with specified group counts.

Public Attributes
xiiUInt32	m_uiThreadGroupCountX = 1U
	Thread groups along X.
xiiUInt32	m_uiThreadGroupCountY = 1U
	Thread groups along Y.
xiiUInt32	m_uiThreadGroupCountZ = 1U
	Thread groups along Z.
xiiUInt32	m_uiMtlThreadGroupSizeX = 0U
	Metal-specific override for threads per group (X).
xiiUInt32	m_uiMtlThreadGroupSizeY = 0U
	Metal-specific override for threads per group (Y).
xiiUInt32	m_uiMtlThreadGroupSizeZ = 0U
	Metal-specific override for threads per group (Z).

Detailed Description

Describes parameters for issuing a compute dispatch call.

Specifies the number of thread groups to launch in each dimension. Metal-specific thread group sizes may be optionally provided for backend tuning.

See also

xiiGALCommandList::Dispatch

Constructor & Destructor Documentation

xiiGALDispatchComputeDescription()

XII_ALWAYS_INLINE xiiGALDispatchComputeDescription::xiiGALDispatchComputeDescription ( xiiUInt32 uiGroupCountX, xiiUInt32 uiGroupCountY, xiiUInt32 uiGroupCountZ = 1U )

inline

Constructs a compute dispatch with specified group counts.

Parameters

uiGroupCountX	- Number of thread groups along X.
uiGroupCountY	- Number of thread groups along Y.
uiGroupCountZ	- Number of thread groups along Z. Defaults to 1.

---

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

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