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.
Public Member Functions | List of all members
AZ::Vulkan::FrameGraphExecuteGroupMerged Class Referencefinal

#include <FrameGraphExecuteGroupMerged.h>

Inherits AZ::Vulkan::FrameGraphExecuteGroupBase.

Public Member Functions

 AZ_CLASS_ALLOCATOR (FrameGraphExecuteGroupMerged, AZ::PoolAllocator)
 
 AZ_RTTI (FrameGraphExecuteGroupMerged, "{85DE8F45-3CA1-4FD9-9B0E-EE98518D2717}", Base)
 
void Init (Device &device, AZStd::vector< const Scope * > &&scopes)
 
void SetPrimaryCommandList (CommandList &commandList)
 Set the command list that the group will use.
 
void SetRenderPasscontexts (AZStd::span< const RenderPassContext > renderPassContexts)
 Set the list of renderpasses that the group will use.
 
AZStd::span< const Scope *const > GetScopes () const override
 
AZStd::span< const RHI::Ptr< CommandList > > GetCommandLists () const override
 
- 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 ExecuteWorkRequest & GetWorkRequest () const
 
RHI::HardwareQueueClass GetHardwareQueueClass () const
 
const RHI::GraphGroupId & GetGroupId () 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.
 
FrameGraphExecuteContext * BeginContext (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< CommandList > AcquireCommandList (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
Device * m_device = nullptr
 
RHI::HardwareQueueClass m_hardwareQueueClass = RHI::HardwareQueueClass::Graphics
 
ExecuteWorkRequest m_workRequest
 
RHI::GraphGroupId m_groupId
 

Detailed Description

Execute group that uses one primary command list to record the work of multiple scopes. The renderpasses and framebuffers are created by the FrameGraphExecuteGroupMergedHandler but they are managed (start and end) by the class itself.

Member Function Documentation

◆ GetCommandLists()

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

Implements AZ::Vulkan::FrameGraphExecuteGroupBase.

◆ GetScopes()

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

Implements AZ::Vulkan::FrameGraphExecuteGroupBase.

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