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::DX12::IndirectBufferSignature Class Referencefinal

#include <IndirectBufferSignature.h>

Inherits AZ::RHI::IndirectBufferSignature.

Public Member Functions

 AZ_CLASS_ALLOCATOR (IndirectBufferSignature, AZ::ThreadPoolAllocator)
 
 AZ_RTTI (IndirectBufferSignature, "{3BAE9C56-555B-4145-96B6-07C81FF9D3AC}", Base)
 
ID3D12CommandSignature * Get () const
 
- Public Member Functions inherited from AZ::RHI::IndirectBufferSignature
 AZ_RTTI (IndirectBufferSignature, "{3A2F9DF0-589B-4E05-9205-B688EB896AEA}", Base)
 
ResultCode Init (Device &device, const IndirectBufferSignatureDescriptor &descriptor)
 
uint32_t GetByteStride () const
 Returns the stride in bytes of the command sequence defined by the provided layout.
 
uint32_t GetOffset (IndirectCommandIndex index) const
 
const IndirectBufferSignatureDescriptorGetDescriptor () const
 
const IndirectBufferLayoutGetLayout () const
 
void Shutdown () final
 Clears the current bound device to null.
 
- 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< IndirectBufferSignatureCreate ()
 

Additional Inherited Members

- 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
 

Detailed Description

DX12 implementation of the RHI IndirectBufferSignature. It represents the DX12 object ID3D12CommandSignature when doing indirect rendering.


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