Open 3D Engine Atom Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Metal::Device Class Referencefinal

Inherits AZ::RHI::Device.

Public Member Functions

 AZ_CLASS_ALLOCATOR (Device, AZ::SystemAllocator)
 
 AZ_RTTI (Device, "{04DA2F69-1E6F-42A1-B4F0-7ADC127A5AAB}", Base)
 
MemoryView CreateImageCommitted (const RHI::ImageDescriptor &imageDescriptor)
 
MemoryView CreateImageCommitted (const RHI::ImageDescriptor &imageDescriptor, MTLStorageMode overrideStorageMode)
 
MemoryView CreateImagePlaced (const RHI::ImageDescriptor &imageDescriptor, id< MTLHeap > mtlHeap, size_t heapByteOffset, MTLSizeAndAlign textureSizeAndAlign)
 
MemoryView CreateImagePlaced (const RHI::ImageDescriptor &imageDescriptor, id< MTLHeap > mtlHeap, size_t heapByteOffset, MTLSizeAndAlign textureSizeAndAlign, MTLTextureType overrideTextureType)
 
MemoryView CreateBufferCommitted (const RHI::BufferDescriptor &bufferDescriptor, RHI::HeapMemoryLevel heapMemoryLevel=RHI::HeapMemoryLevel::Device)
 
MemoryView CreateBufferPlaced (const RHI::BufferDescriptor &bufferDescriptor, id< MTLHeap > mtlHeap, size_t heapByteOffset, MTLSizeAndAlign bufferSizeAndAlign)
 
MemoryView CreateResourceCommitted (ResourceDescriptor resourceDesc)
 
id< MTLDevice > GetMtlDevice ()
 
MTLSharedEventListener * GetSharedEventListener ()
 
void QueueDeferredRelease (RHI::Ptr< RHI::Object > object)
 
CommandListPoolGetCommandListPool (RHI::HardwareQueueClass hardwareQueueClass)
 
CommandQueueGetGraphicsCommandQueue ()
 
const CommandQueueGetGraphicsCommandQueue () const
 
CommandQueueGetCopyCommandQueue ()
 
const CommandQueueGetCopyCommandQueue () const
 
CommandQueueGetComputeCommandQueue ()
 
const CommandQueueGetComputeCommandQueue () const
 
CommandListAcquireCommandList (RHI::HardwareQueueClass hardwareQueueClass)
 
void QueueForRelease (const MemoryView &memoryView)
 
void QueueForRelease (Memory *memory)
 
RHI::ConstPtr< PipelineLayoutAcquirePipelineLayout (const RHI::PipelineLayoutDescriptor &descriptor)
 Acquires a pipeline layout from the internal cache.
 
RHI::Ptr< BufferAcquireStagingBuffer (AZStd::size_t byteCount, RHI::BufferBindFlags bufferBindFlags)
 
CommandQueueContextGetCommandQueueContext ()
 
const CommandQueueContextGetCommandQueueContext () const
 
AsyncUploadQueueGetAsyncUploadQueue ()
 
const AsyncUploadQueueGetAsyncUploadQueue () const
 
const NSCache * GetSamplerCache () const
 
BufferMemoryAllocatorGetArgBufferConstantBufferAllocator ()
 
BufferMemoryAllocatorGetArgumentBufferAllocator ()
 
NullDescriptorManagerGetNullDescriptorManager ()
 
RHI::ResourceMemoryRequirements GetResourceMemoryRequirements (const RHI::ImageDescriptor &descriptor) override
 Get the memory requirements for allocating an image resource.
 
RHI::ResourceMemoryRequirements GetResourceMemoryRequirements (const RHI::BufferDescriptor &descriptor) override
 Get the memory requirements for allocating a buffer resource.
 
void ObjectCollectionNotify (RHI::ObjectCollectorNotifyFunction notifyFunction) override
 Notifies after all objects currently in the platform release queue are released.
 
BindlessArgumentBufferGetBindlessArgumentBuffer ()
 
- Public Member Functions inherited from AZ::RHI::Device
 AZ_RTTI (Device, "{C7E70BE4-3AA5-4214-91E6-52A8ECC31A34}", Object)
 
bool IsInitialized () const
 Returns whether the device is initialized.
 
ResultCode Init (int deviceIndex, PhysicalDevice &physicalDevice)
 
ResultCode BeginFrame ()
 
ResultCode EndFrame ()
 
ResultCode WaitForIdle ()
 
ResultCode CompileMemoryStatistics (MemoryStatistics &memoryStatistics, MemoryStatisticsReportFlags reportFlags)
 
ResultCode UpdateCpuTimingStatistics () const
 
const PhysicalDeviceGetPhysicalDevice () const
 Returns the physical device associated with this device.
 
int GetDeviceIndex () const
 Returns the device index.
 
const DeviceDescriptorGetDescriptor () const
 Returns the descriptor associated with the device.
 
const DeviceFeaturesGetFeatures () const
 Returns the set of features supported by this device.
 
const DeviceLimitsGetLimits () const
 Returns the set of hardware limits for this device.
 
const ResourcePoolDatabaseGetResourcePoolDatabase () const
 Returns the resource pool database.
 
ResourcePoolDatabaseGetResourcePoolDatabase ()
 Returns the mutable resource pool database.
 
FormatCapabilities GetFormatCapabilities (Format format) const
 Returns a union of all capabilities of a specific format.
 
Format GetNearestSupportedFormat (Format requestedFormat, FormatCapabilities requestedCapabilities) const
 Return the nearest supported format for this device.
 
ResultCode InitBindlessSrg (RHI::Ptr< RHI::ShaderResourceGroupLayout > bindlessSrgLayout)
 
virtual RHI::ResultCode CompactSRGMemory ()
 Allows the back-ends to compact SRG related memory if applicable.
 
virtual ShadingRateImageValue ConvertShadingRate (ShadingRate rate) const =0
 Converts a shading rate enum to the proper texel value to be used in a shading rate image.
 
bool WasDeviceRemoved ()
 
void SetDeviceRemoved ()
 
void SetLastExecutingScope (const AZStd::string_view scopeName)
 
AZStd::string_view GetLastExecutingScope () const
 
virtual Ptr< XRDeviceDescriptorBuildXRDescriptor () const
 Builds an implementation specific XR device descriptor based on this graphics device.
 
- 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< DeviceCreate ()
 

Additional Inherited Members

- Protected Types inherited from AZ::RHI::Device
using FormatCapabilitiesList = AZStd::array< FormatCapabilities, static_cast< uint32_t >(Format::Count)>
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::Device
DeviceFeatures m_features
 
DeviceLimits m_limits
 
ResourcePoolDatabase m_resourcePoolDatabase
 
DeviceDescriptor m_descriptor
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Member Function Documentation

◆ AcquireCommandList()

CommandList* AZ::Metal::Device::AcquireCommandList ( RHI::HardwareQueueClass  hardwareQueueClass)

Acquires a new command list for the frame given the hardware queue class. The command list is automatically reclaimed after the current frame has flushed through the GPU.

◆ QueueDeferredRelease()

void AZ::Metal::Device::QueueDeferredRelease ( RHI::Ptr< RHI::Object object)

Releases an object through the garbage collector, which will defer release until the current GPU frame has been flushed.

◆ QueueForRelease()

void AZ::Metal::Device::QueueForRelease ( const MemoryView memoryView)

Queues the backing Memory instance of a MemoryView for release (by taking a reference) after the current frame has flushed through the GPU. The reference on the MemoryView itself is not released.


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