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::Metal::CommandQueue Class Referencefinal

Inherits AZ::RHI::CommandQueue.

Public Types

using Descriptor = RHI::CommandQueueDescriptor
 
- Public Types inherited from AZ::RHI::CommandQueue
using Command = AZStd::function< void(void *commandQueue)>
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (CommandQueue, AZ::SystemAllocator)
 
 AZ_RTTI (CommandQueue, "{C50C1546-EC3B-45A3-BF48-C2A99C1BAE8A}", Base)
 
id< MTLCommandQueue > GetPlatformQueue () const
 
CommandQueueCommandBufferGetCommandBuffer ()
 
void ExecuteWork (const RHI::ExecuteWorkRequest &request) override
 
void WaitForIdle () override
 
void QueueGpuSignal (Fence &fence)
 
void QueueGpuSignal (Fence &fence, uint64_t signalValue)
 
void ClearTimers ()
 
AZStd::sys_time_t GetLastExecuteDuration () const
 
AZStd::sys_time_t GetLastPresentDuration () const
 
- Public Member Functions inherited from AZ::RHI::CommandQueue
 AZ_CLASS_ALLOCATOR (CommandQueue, AZ::SystemAllocator)
 
ResultCode Init (Device &device, const CommandQueueDescriptor &descriptor)
 
void Shutdown ()
 
void QueueCommand (Command command)
 
void FlushCommands ()
 
RHI::HardwareQueueClass GetHardwareQueueClass () const
 
const CommandQueueDescriptorGetDescriptor () const
 
- Public Member Functions inherited from AZ::RHI::DeviceObject
 AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
 
bool IsInitialized () const
 Returns whether the device object is initialized.
 
DeviceGetDevice () const
 
- Public Member Functions inherited from AZ::RHI::Object
 AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")
 
void SetName (const Name &name)
 Sets the name of the object.
 
const Name & GetName () const
 Returns the name set on the object by SetName.
 
uint32_t use_count ()
 Returns the current use count of the object.
 

Static Public Member Functions

static RHI::Ptr< CommandQueueCreate ()
 

Additional Inherited Members

virtual void ExecuteWork (const ExecuteWorkRequest &request)=0
 
virtual void WaitForIdle ()=0
 
virtual void * GetNativeQueue ()=0
 
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
void Shutdown () override
 Clears the current bound device to null.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Member Function Documentation

◆ ExecuteWork()

void AZ::Metal::CommandQueue::ExecuteWork ( const RHI::ExecuteWorkRequest request)
overridevirtual

Implements AZ::RHI::CommandQueue.

◆ WaitForIdle()

void AZ::Metal::CommandQueue::WaitForIdle ( )
overridevirtual

Implements AZ::RHI::CommandQueue.


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