Open 3D Engine Atom Gem API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Null::CommandList Class Referencefinal

Inherits AZ::RHI::CommandList, and AZ::RHI::DeviceObject.

Public Member Functions

 AZ_CLASS_ALLOCATOR (CommandList, AZ::SystemAllocator)
 
 AZ_RTTI (CommandList, "{265B877D-21DC-48FF-9D82-AA30C3E16422}", Base)
 
void SetViewports (const RHI::Viewport *viewports, uint32_t count) override
 Assigns a list of viewports to the raster stage of the graphics pipe.
 
void SetScissors (const RHI::Scissor *scissors, uint32_t count) override
 Assigns a list of scissors to the raster stage of the graphics pipe.
 
void SetShaderResourceGroupForDraw (const RHI::DeviceShaderResourceGroup &shaderResourceGroup) override
 
void SetShaderResourceGroupForDispatch (const RHI::DeviceShaderResourceGroup &shaderResourceGroup) override
 
void Submit (const RHI::DeviceDrawItem &drawItem, uint32_t submitIndex=0) override
 Submits a single draw item for processing on the command list.
 
void Submit (const RHI::DeviceCopyItem &copyItem, uint32_t submitIndex=0) override
 Submits a single copy item for processing on the command list.
 
void Submit (const RHI::DeviceDispatchItem &dispatchItem, uint32_t submitIndex=0) override
 Submits a single dispatch item for processing on the command list.
 
void Submit (const RHI::DeviceDispatchRaysItem &dispatchRaysItem, uint32_t submitIndex=0) override
 Submits a single dispatch rays item for processing on the command list.
 
void BeginPredication (const RHI::DeviceBuffer &buffer, uint64_t offset, RHI::PredicationOp operation) override
 Starts predication on the command list.
 
void EndPredication () override
 End predication on the command list.
 
void BuildBottomLevelAccelerationStructure (const RHI::DeviceRayTracingBlas &rayTracingBlas) override
 Builds a Bottom Level Acceleration Structure (BLAS) for ray tracing operations, which is made up of DeviceRayTracingGeometry entries.
 
void UpdateBottomLevelAccelerationStructure (const RHI::DeviceRayTracingBlas &rayTracingBlas) override
 Updates a Bottom Level Acceleration Structure (BLAS) for ray tracing operations, which is made up of DeviceRayTracingGeometry entries.
 
void QueryBlasCompactionSizes (const AZStd::vector< AZStd::pair< RHI::DeviceRayTracingBlas *, RHI::DeviceRayTracingCompactionQuery * > > &) override
 
void CompactBottomLevelAccelerationStructure (const RHI::DeviceRayTracingBlas &, const RHI::DeviceRayTracingBlas &) override
 Copies the given sourceBlas into the compactBlas.
 
void BuildTopLevelAccelerationStructure (const RHI::DeviceRayTracingTlas &rayTracingTlas, const AZStd::vector< const RHI::DeviceRayTracingBlas * > &changedBlasList) override
 
void SetFragmentShadingRate (RHI::ShadingRate rate, const RHI::ShadingRateCombinators &combinators=DefaultShadingRateCombinators) override
 
void Shutdown () override
 
- Public Member Functions inherited from AZ::RHI::CommandList
void SetScissor (const Scissor &scissor)
 Assigns a scissor to the raster stage of the graphics pipe.
 
void SetViewport (const Viewport &viewport)
 Assigns a viewport to the raster stage of the graphics pipe.
 
virtual void QueryBlasCompactionSizes (const AZStd::vector< AZStd::pair< RHI::DeviceRayTracingBlas *, RHI::DeviceRayTracingCompactionQuery * > > &blasToQuery)=0
 Inserts queries for the size of the compacted Blas.
 
virtual void BuildTopLevelAccelerationStructure (const RHI::DeviceRayTracingTlas &rayTracingTlas, const AZStd::vector< const RHI::DeviceRayTracingBlas * > &changedBlasList)=0
 
void SetSubmitRange (const SubmitRange &submitRange)
 Sets the submit range for this command list.
 
void ValidateSubmitIndex (uint32_t submitIndex)
 Validates a submit index against the range for this command list, and tracks the total number of submits.
 
void ValidateTotalSubmits (const ScopeProducer *scopeProducer)
 Validates the total number of submits against the expected number.
 
void ResetTotalSubmits ()
 Resets the total number of submits.
 
- Public Member Functions inherited from AZ::RHI::DeviceObject
 AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
 
bool IsInitialized () const
 Returns whether the device object is initialized.
 
DeviceGetDevice () const
 
- Public Member Functions inherited from AZ::RHI::Object
 AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")
 
void SetName (const Name &name)
 Sets the name of the object.
 
const Name & GetName () const
 Returns the name set on the object by SetName.
 
uint32_t use_count ()
 Returns the current use count of the object.
 

Static Public Member Functions

static RHI::Ptr< CommandListCreate ()
 

Additional Inherited Members

- Static Public Attributes inherited from AZ::RHI::CommandList
static const ShadingRateCombinators DefaultShadingRateCombinators
 Default value of shading rate combinator operations.
 
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
void Shutdown () override
 Clears the current bound device to null.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Member Function Documentation

◆ BeginPredication()

void AZ::Null::CommandList::BeginPredication ( const RHI::DeviceBuffer buffer,
uint64_t  offset,
RHI::PredicationOp  operation 
)
inlineoverridevirtual

Starts predication on the command list.

Implements AZ::RHI::CommandList.

◆ BuildBottomLevelAccelerationStructure()

void AZ::Null::CommandList::BuildBottomLevelAccelerationStructure ( const RHI::DeviceRayTracingBlas rayTracingBlas)
inlineoverridevirtual

Builds a Bottom Level Acceleration Structure (BLAS) for ray tracing operations, which is made up of DeviceRayTracingGeometry entries.

Implements AZ::RHI::CommandList.

◆ CompactBottomLevelAccelerationStructure()

void AZ::Null::CommandList::CompactBottomLevelAccelerationStructure ( const RHI::DeviceRayTracingBlas sourceBlas,
const RHI::DeviceRayTracingBlas compactBlas 
)
inlineoverridevirtual

Copies the given sourceBlas into the compactBlas.

Implements AZ::RHI::CommandList.

◆ EndPredication()

void AZ::Null::CommandList::EndPredication ( )
inlineoverridevirtual

End predication on the command list.

Implements AZ::RHI::CommandList.

◆ SetFragmentShadingRate()

void AZ::Null::CommandList::SetFragmentShadingRate ( RHI::ShadingRate  rate,
const RHI::ShadingRateCombinators &  combinators = DefaultShadingRateCombinators 
)
inlineoverridevirtual

Sets the Per-Draw shading rate value. This rate will be used for all subsequent draw calls of this command list. Combinators can also be specified as part of setting the rate. For ShadingRateCombinators = { Op1, Op2 }, the final value is calculated as Op2(Op1(PerDraw, PerPrimitive), PerRegion)

Implements AZ::RHI::CommandList.

◆ SetScissors()

void AZ::Null::CommandList::SetScissors ( const RHI::Scissor scissors,
uint32_t  count 
)
inlineoverridevirtual

Assigns a list of scissors to the raster stage of the graphics pipe.

Implements AZ::RHI::CommandList.

◆ SetShaderResourceGroupForDispatch()

void AZ::Null::CommandList::SetShaderResourceGroupForDispatch ( const RHI::DeviceShaderResourceGroup shaderResourceGroup)
inlineoverridevirtual

Assigns a shader resource group for dispatch on compute pipe, at the binding slot determined by the layout used to create the shader resource group.

Parameters
shaderResourceGroupThe shader resource group to bind.

Implements AZ::RHI::CommandList.

◆ SetShaderResourceGroupForDraw()

void AZ::Null::CommandList::SetShaderResourceGroupForDraw ( const RHI::DeviceShaderResourceGroup shaderResourceGroup)
inlineoverridevirtual

Assigns a shader resource group for draw on the graphics pipe, at the binding slot determined by the layout used to create the shader resource group.

Parameters
shaderResourceGroupThe shader resource group to bind.

Implements AZ::RHI::CommandList.

◆ SetViewports()

void AZ::Null::CommandList::SetViewports ( const RHI::Viewport viewports,
uint32_t  count 
)
inlineoverridevirtual

Assigns a list of viewports to the raster stage of the graphics pipe.

Implements AZ::RHI::CommandList.

◆ Shutdown()

void AZ::Null::CommandList::Shutdown ( )
overridevirtual

Shuts down the object. Derived classes can make this public if it fits with their lifecycle model (i.e. if they use an explicit Init / Shutdown). By default, it is private in order to maintain consistency with a simpler RAII lifecycle.

Reimplemented from AZ::RHI::Object.

◆ Submit() [1/4]

void AZ::Null::CommandList::Submit ( const RHI::DeviceCopyItem copyItem,
uint32_t  submitIndex = 0 
)
inlineoverridevirtual

Submits a single copy item for processing on the command list.

Implements AZ::RHI::CommandList.

◆ Submit() [2/4]

void AZ::Null::CommandList::Submit ( const RHI::DeviceDispatchItem dispatchItem,
uint32_t  submitIndex = 0 
)
inlineoverridevirtual

Submits a single dispatch item for processing on the command list.

Implements AZ::RHI::CommandList.

◆ Submit() [3/4]

void AZ::Null::CommandList::Submit ( const RHI::DeviceDispatchRaysItem dispatchRaysItem,
uint32_t  submitIndex = 0 
)
inlineoverridevirtual

Submits a single dispatch rays item for processing on the command list.

Implements AZ::RHI::CommandList.

◆ Submit() [4/4]

void AZ::Null::CommandList::Submit ( const RHI::DeviceDrawItem drawItem,
uint32_t  submitIndex = 0 
)
inlineoverridevirtual

Submits a single draw item for processing on the command list.

Implements AZ::RHI::CommandList.

◆ UpdateBottomLevelAccelerationStructure()

void AZ::Null::CommandList::UpdateBottomLevelAccelerationStructure ( const RHI::DeviceRayTracingBlas rayTracingBlas)
inlineoverridevirtual

Updates a Bottom Level Acceleration Structure (BLAS) for ray tracing operations, which is made up of DeviceRayTracingGeometry entries.

Implements AZ::RHI::CommandList.


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