Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::RHI::IndirectArguments Struct Reference

#include <IndirectArguments.h>

Public Member Functions

 IndirectArguments (uint32_t maxSequenceCount, const IndirectBufferView &indirectBuffer, uint64_t indirectBufferByteOffset)
 
 IndirectArguments (uint32_t maxSequenceCount, const IndirectBufferView &indirectBuffer, uint64_t indirectBufferByteOffset, const Buffer *countBuffer, uint64_t countBufferByteOffset)
 

Public Attributes

uint32_t m_maxSequenceCount = 0
 
uint64_t m_indirectBufferByteOffset = 0
 Specifies an offset into IndirectBufferView to identify the first command argument.
 
uint64_t m_countBufferByteOffset = 0
 Specifies an offset into m_countBuffer, identifying the argument count.
 
const IndirectBufferViewm_indirectBufferView = nullptr
 View over the Indirect buffer that contains the commands.
 
const Bufferm_countBuffer = nullptr
 Optional count buffer that contains the number of indirect commands in the indirect buffer.
 

Detailed Description

Encapsulates the arguments needed when doing an indirect call (draw or dispatch) into a command list.

Member Data Documentation

◆ m_maxSequenceCount

uint32_t AZ::RHI::IndirectArguments::m_maxSequenceCount = 0

There are two ways that m_maxSequenceCount can be specified: 1) If m_countBuffer is not NULL, then m_maxSequenceCount specifies the maximum number of operations which will be performed. The actual number of operations to be performed are defined by the minimum of this value, and a 32 bit unsigned integer contained in m_countBuffer(at the byte offset specified by m_countBufferByteOffset). 2) If m_countBuffer is NULL, the m_maxSequenceCount specifies the exact number of operations which will be performed.


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