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

#include <FrameGraphExecuteGroupSecondary.h>

Inherits AZ::Metal::FrameGraphExecuteGroup.

Public Member Functions

 AZ_CLASS_ALLOCATOR (FrameGraphExecuteGroupSecondary, AZ::SystemAllocator)
 
 AZ_RTTI (FrameGraphExecuteGroupSecondary, "{17E690A6-CE8F-4C7B-8C48-E0939152FBC0}", Base)
 
void Init (Device &device, Scope &scope, uint32_t commandListCount, RHI::JobPolicy globalJobPolicy)
 
AZStd::span< const Scope *const > GetScopes () const override
 
AZStd::span< Scope *const > GetScopes () override
 
void SetRenderContext (const RenderPassContext &renderPassContext)
 
const Scope * GetScope () const
 Returns the scope of this group. There's only one scope.
 
void EncondeAllWaitEvents () const
 Encodes all wait events for the group and the scope.
 
void EncodeAllSignalEvents () const
 Encodes all signal events for the group and the scope.
 
void CreateSecondaryEncoders ()
 Creates the sub encoders that will be used for recording the work of the scope.
 
- Public Member Functions inherited from AZ::Metal::FrameGraphExecuteGroup
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.
 
- 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
 

Additional Inherited Members

- Public Types inherited from AZ::Metal::FrameGraphExecuteGroup
using CallbackFunc = AZStd::function< void(const FrameGraphExecuteGroup *groupBase)>
 
- Protected Member Functions inherited from AZ::Metal::FrameGraphExecuteGroup
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 inherited from AZ::Metal::FrameGraphExecuteGroup
ExecuteWorkRequest m_workRequest
 
RHI::HardwareQueueClass m_hardwareQueueClass = RHI::HardwareQueueClass::Graphics
 
CommandQueueCommandBuffer * m_commandBuffer = nullptr
 

Detailed Description

Execute group for one scope that uses multiple encoders to record it's work. Renderpass (if needed) are handled by the FrameGraphExecuteGroupSecondaryHandler.

Member Function Documentation

◆ GetScopes() [1/2]

AZStd::span< const Scope *const > AZ::Metal::FrameGraphExecuteGroupSecondary::GetScopes ( ) const
overridevirtual

◆ GetScopes() [2/2]

AZStd::span< Scope *const > AZ::Metal::FrameGraphExecuteGroupSecondary::GetScopes ( )
overridevirtual

◆ SetRenderContext()

void AZ::Metal::FrameGraphExecuteGroupSecondary::SetRenderContext ( const RenderPassContext &  renderPassContext)

Set the render context and subpass that will be used by this execute group. This render context is the same for all other FrameGraphExecuteGroupSecondary of the handler.


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