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::Vulkan::FrameGraphExecuteGroup Class Referencefinal

#include <FrameGraphExecuteGroup.h>

Inherits AZ::Vulkan::FrameGraphExecuteGroupBase.

Public Member Functions

 AZ_CLASS_ALLOCATOR (FrameGraphExecuteGroup, AZ::SystemAllocator)
 
 AZ_RTTI (FrameGraphExecuteGroup, "{D3BDC3AC-06A7-4067-9E71-0DBB3A80B188}", Base)
 
void Init (Device &device, const Scope &scope, uint32_t commandListCount, RHI::JobPolicy globalJobPolicy)
 
AZStd::span< const Scope *const > GetScopes () const override
 
AZStd::span< const RHI::Ptr< CommandList > > GetCommandLists () const override
 
void SetRenderContext (const RenderPassContext &renderPassContext, uint32_t subpassIndex=0)
 Set the render context and subpass that will be used by this execute group.
 
- Public Member Functions inherited from AZ::Vulkan::FrameGraphExecuteGroupBase
 AZ_RTTI (FrameGraphExecuteGroupBase, "{8F39B46F-37D3-4026-AB1A-A78F646F311B}", Base)
 
void InitBase (Device &device, const RHI::GraphGroupId &groupId, RHI::HardwareQueueClass hardwareQueueClass)
 
const ExecuteWorkRequestGetWorkRequest () const
 
RHI::HardwareQueueClass GetHardwareQueueClass () const
 
const RHI::GraphGroupIdGetGroupId () const
 
virtual AZStd::span< const Scope *const > GetScopes () const =0
 
virtual AZStd::span< const RHI::Ptr< CommandList > > GetCommandLists () const =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.
 
FrameGraphExecuteContextBeginContext (uint32_t contextindex)
 Begins the context at index.
 
void EndContext (uint32_t contextIndex)
 
JobPolicy GetJobPolicy () const
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::Vulkan::FrameGraphExecuteGroupBase
RHI::Ptr< CommandListAcquireCommandList (VkCommandBufferLevel level) const
 
- Protected Member Functions inherited from AZ::RHI::FrameGraphExecuteGroup
void Init (const InitRequest &request)
 
void Init (const InitMergedRequest &request)
 
- Protected Attributes inherited from AZ::Vulkan::FrameGraphExecuteGroupBase
Devicem_device = nullptr
 
RHI::HardwareQueueClass m_hardwareQueueClass = RHI::HardwareQueueClass::Graphics
 
ExecuteWorkRequest m_workRequest
 
RHI::GraphGroupId m_groupId
 

Detailed Description

Execute group for one scope that uses one or more secondary command lists to record it's work. Renderpass and framebuffers are handled by the FrameGraphExecuteGroupHandler.

Constructor & Destructor Documentation

◆ ~FrameGraphExecuteGroup()

AZ::Vulkan::FrameGraphExecuteGroup::~FrameGraphExecuteGroup ( )
virtualdefault

Reimplemented from AZ::RHI::FrameGraphExecuteGroup.

Member Function Documentation

◆ GetCommandLists()

AZStd::span< const RHI::Ptr< CommandList > > AZ::Vulkan::FrameGraphExecuteGroup::GetCommandLists ( ) const
overridevirtual

◆ GetScopes()

AZStd::span< const Scope *const > AZ::Vulkan::FrameGraphExecuteGroup::GetScopes ( ) const
overridevirtual

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