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::FrameGraphExecuter Class Referencefinal

Inherits AZ::RHI::FrameGraphExecuter.

Public Member Functions

 AZ_CLASS_ALLOCATOR (FrameGraphExecuter, AZ::SystemAllocator)
 
DeviceGetDevice () const
 
- Public Member Functions inherited from AZ::RHI::FrameGraphExecuter
 AZ_RTTI (FrameGraphExecuter, "{9DF0B900-A426-4056-8638-38A5007825F5}", Object)
 
ResultCode Init (const FrameGraphExecuterDescriptor &descriptor)
 
void Shutdown () override final
 
JobPolicy GetJobPolicy () const
 
uint32_t GetGroupCount () const
 
void Begin (const FrameGraph &frameGraph)
 
FrameGraphExecuteGroupBeginGroup (uint32_t groupIndex)
 
void EndGroup (uint32_t groupIndex)
 
void End ()
 
- 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< FrameGraphExecuterCreate ()
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::FrameGraphExecuter
void SetJobPolicy (JobPolicy jobPolicy)
 
template<typename FrameGraphExecuteGroupType >
FrameGraphExecuteGroupType * AddGroup ()
 
AZStd::span< const AZStd::unique_ptr< FrameGraphExecuteGroup > > GetGroups () const
 Returns a list of the registered execute groups.
 
- 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
 

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