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::FrameGraphExecuteGroupBase Class Referenceabstract

#include <FrameGraphExecuteGroupBase.h>

Inherits AZ::RHI::FrameGraphExecuteGroup.

Inherited by AZ::Vulkan::FrameGraphExecuteGroup, and AZ::Vulkan::FrameGraphExecuteGroupMerged.

Public Member Functions

 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
 

Protected Member Functions

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

Devicem_device = nullptr
 
RHI::HardwareQueueClass m_hardwareQueueClass = RHI::HardwareQueueClass::Graphics
 
ExecuteWorkRequest m_workRequest
 
RHI::GraphGroupId m_groupId
 

Detailed Description

Base class for the Execute group classes. It encapsulates the common functionality for Execute groups like the work request that will be used and the hardwareQueueClass for all scopes in the group.


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