xiiGALDispatchComputeIndirectDescription Struct Reference

Describes parameters for issuing an indirect compute dispatch call. More...

#include <CommandList.h>

Public Member Functions
XII_ALWAYS_INLINE	xiiGALDispatchComputeIndirectDescription ()=default
	Default-initialized indirect compute dispatch.
XII_ALWAYS_INLINE	xiiGALDispatchComputeIndirectDescription (xiiSharedPtr< xiiGALBuffer > pBuffer, xiiEnum< xiiGALStateTransitionMode > bufferTransitionMode, xiiUInt64 uiDispatchArgumentOffset=0U)
	Constructs an indirect compute dispatch with specified parameters.

Public Attributes
xiiSharedPtr< xiiGALBuffer >	m_pBuffer = nullptr
	Buffer containing dispatch arguments.
xiiEnum< xiiGALStateTransitionMode >	m_BufferTransitionMode = xiiGALStateTransitionMode::None
	State transition mode.
xiiUInt64	m_uiDispatchArgumentOffset = 0U
	Byte offset to the dispatch arguments.
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 an indirect compute dispatch call.

Dispatch arguments are read from a GPU buffer. Metal-specific thread group sizes may be optionally provided for backend tuning.

See also

xiiGALCommandList::DispatchIndirect

Constructor & Destructor Documentation

xiiGALDispatchComputeIndirectDescription()

XII_ALWAYS_INLINE xiiGALDispatchComputeIndirectDescription::xiiGALDispatchComputeIndirectDescription ( xiiSharedPtr< xiiGALBuffer > pBuffer, xiiEnum< xiiGALStateTransitionMode > bufferTransitionMode, xiiUInt64 uiDispatchArgumentOffset = 0U )

inline

Constructs an indirect compute dispatch with specified parameters.

Parameters

pBuffer	- Buffer containing dispatch arguments.
bufferTransitionMode	- Resource state transition mode for the buffer.
uiDispatchArgumentOffset	- Byte offset to the dispatch arguments.

---

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

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