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

Inherits AZ::RHI::FrameGraphExecuteGroup.

Inherited by AZ::Metal::FrameGraphExecuteGroupPrimary, and AZ::Metal::FrameGraphExecuteGroupSecondary.

Public Types

using CallbackFunc = AZStd::function< void(const FrameGraphExecuteGroup *groupBase)>
 

Public Member Functions

void InitBase (Device &device, const RHI::GraphGroupId &groupId, RHI::HardwareQueueClass hardwareQueueClass)
 
Device & GetDevice () const
 
ExecuteWorkRequest && AcquireWorkRequest ()
 
RHI::HardwareQueueClass GetHardwareQueueClass ()
 
const RHI::GraphGroupId & GetGroupId () const
 Returns the group id of this FrameGraphExecuteGroup (used for subpass grouping)
 
void SetCommandBuffer (CommandQueueCommandBuffer *commandBuffer)
 Set the command buffer that the group will use.
 
void SetHandler (FrameGraphExecuteGroupHandler *handler)
 Set the FrameGraphExecuteGroupHandler that this group belongs.
 
virtual AZStd::span< const Scope *const > GetScopes () const =0
 
virtual AZStd::span< Scope *const > GetScopes ()=0
 
- Public Member Functions inherited from AZ::RHI::FrameGraphExecuteGroup
 AZ_RTTI (FrameGraphExecuteGroup, "{159FAD55-17EC-4B09-986F-01B740F96448}")
 
bool IsComplete () const
 
bool IsSubmittable () const
 
uint32_t GetContextCount () const
 Returns the number of execute contexts in the group.
 
FrameGraphExecuteContext * BeginContext (uint32_t contextindex)
 Begins the context at index.
 
void EndContext (uint32_t contextIndex)
 
JobPolicy GetJobPolicy () const
 

Protected Member Functions

CommandList * AcquireCommandList () const
 
void EncodeWaitEvents () const
 Go through all the wait fences across all queues and encode them if needed.
 
- Protected Member Functions inherited from AZ::RHI::FrameGraphExecuteGroup
void Init (const InitRequest &request)
 
void Init (const InitMergedRequest &request)
 

Protected Attributes

ExecuteWorkRequest m_workRequest
 
RHI::HardwareQueueClass m_hardwareQueueClass = RHI::HardwareQueueClass::Graphics
 
CommandQueueCommandBuffer * m_commandBuffer = nullptr
 

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