Open 3D Engine Atom Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
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 ([[maybe_unused]] const RHI::Viewport *viewports, [[maybe_unused]] uint32_t count) override
 
void SetScissors ([[maybe_unused]] const RHI::Scissor *scissors, [[maybe_unused]] uint32_t count) override
 
void SetShaderResourceGroupForDraw ([[maybe_unused]] const RHI::ShaderResourceGroup &shaderResourceGroup) override
 
void SetShaderResourceGroupForDispatch ([[maybe_unused]] const RHI::ShaderResourceGroup &shaderResourceGroup) override
 
void Submit ([[maybe_unused]] const RHI::DrawItem &drawItem, [[maybe_unused]] uint32_t submitIndex=0) override
 
void Submit ([[maybe_unused]] const RHI::CopyItem &copyItem, [[maybe_unused]] uint32_t submitIndex=0) override
 
void Submit ([[maybe_unused]] const RHI::DispatchItem &dispatchItem, [[maybe_unused]] uint32_t submitIndex=0) override
 
void Submit ([[maybe_unused]] const RHI::DispatchRaysItem &dispatchRaysItem, [[maybe_unused]] uint32_t submitIndex=0) override
 
void BeginPredication ([[maybe_unused]] const RHI::Buffer &buffer, [[maybe_unused]] uint64_t offset, [[maybe_unused]] RHI::PredicationOp operation) override
 
void EndPredication () override
 End predication on the command list.
 
void BuildBottomLevelAccelerationStructure ([[maybe_unused]] const RHI::RayTracingBlas &rayTracingBlas) override
 
void BuildTopLevelAccelerationStructure ([[maybe_unused]] const RHI::RayTracingTlas &rayTracingTlas) override
 
void SetFragmentShadingRate ([[maybe_unused]] RHI::ShadingRate rate, [[maybe_unused]] const RHI::ShadingRateCombinators &combinators=DefaultShadingRateCombinators) override
 
void Shutdown () override
 Clears the current bound device to null.
 
- Public Member Functions inherited from AZ::RHI::CommandList
virtual void SetViewports (const Viewport *viewports, uint32_t count)=0
 Assigns a list of viewports to the raster stage of the graphics pipe.
 
virtual void SetScissors (const Scissor *scissors, uint32_t count)=0
 Assigns a list of scissors to the raster stage of the graphics pipe.
 
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 SetShaderResourceGroupForDraw (const ShaderResourceGroup &shaderResourceGroup)=0
 
virtual void SetShaderResourceGroupForDispatch (const ShaderResourceGroup &shaderResourceGroup)=0
 
virtual void Submit (const CopyItem &copyItem, uint32_t submitIndex=0)=0
 Submits a single copy item for processing on the command list.
 
virtual void Submit (const DrawItem &drawItem, uint32_t submitIndex=0)=0
 Submits a single draw item for processing on the command list.
 
virtual void Submit (const DispatchItem &dispatchItem, uint32_t submitIndex=0)=0
 Submits a single dispatch item for processing on the command list.
 
virtual void Submit (const DispatchRaysItem &dispatchRaysItem, uint32_t submitIndex=0)=0
 Submits a single dispatch rays item for processing on the command list.
 
virtual void BeginPredication (const Buffer &buffer, uint64_t offset, PredicationOp operation)=0
 Starts predication on the command list.
 
virtual void BuildBottomLevelAccelerationStructure (const RHI::RayTracingBlas &rayTracingBlas)=0
 Builds a Bottom Level Acceleration Structure (BLAS) for ray tracing operations, which is made up of RayTracingGeometry entries.
 
virtual void BuildTopLevelAccelerationStructure (const RHI::RayTracingTlas &rayTracingTlas)=0
 Builds a Top Level Acceleration Structure (TLAS) for ray tracing operations, which is made up of RayTracingInstance entries that refer to a BLAS entry.
 
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.
 
virtual void SetFragmentShadingRate (ShadingRate rate, const ShadingRateCombinators &combinators=DefaultShadingRateCombinators)=0
 
- 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.
 
Device & GetDevice () 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< CommandList > Create ()
 

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.
 
- 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
 
The documentation for this class was generated from the following file: