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

#include <DeviceObject.h>

Inherits AZ::RHI::Object.

Inherited by AZ::DX12::AsyncUploadQueue, AZ::DX12::CommandListBase, AZ::DX12::Sampler, AZ::Metal::ArgumentBuffer, AZ::Metal::AsyncUploadQueue, AZ::Metal::NullDescriptorManager, AZ::Null::CommandList, AZ::RHI::AliasedAttachmentAllocator< Heap >, AZ::RHI::CommandQueue, AZ::RHI::Fence, AZ::RHI::FrameGraphCompiler, AZ::RHI::FrameGraphExecuter, AZ::RHI::IndirectBufferSignature, AZ::RHI::PipelineLibrary, AZ::RHI::PipelineState, AZ::RHI::RayTracingBlas, AZ::RHI::RayTracingBufferPools, AZ::RHI::RayTracingPipelineState, AZ::RHI::RayTracingShaderTable, AZ::RHI::RayTracingTlas, AZ::RHI::Resource, AZ::RHI::ResourcePool, AZ::RHI::ResourceView, AZ::RHI::TransientAttachmentPool, AZ::Vulkan::AsyncUploadQueue, AZ::Vulkan::BufferMemory, AZ::Vulkan::CommandList, AZ::Vulkan::CommandPool, AZ::Vulkan::DescriptorPool, AZ::Vulkan::DescriptorSet, AZ::Vulkan::DescriptorSetAllocator, AZ::Vulkan::DescriptorSetLayout, AZ::Vulkan::Framebuffer, AZ::Vulkan::Memory, AZ::Vulkan::MemoryTypeAllocator< SubAllocator, View >, AZ::Vulkan::NullDescriptorManager, AZ::Vulkan::Pipeline, AZ::Vulkan::PipelineLayout, AZ::Vulkan::Queue, AZ::Vulkan::RenderPass, AZ::Vulkan::Sampler, AZ::Vulkan::Semaphore, AZ::Vulkan::ShaderModule, AZ::Vulkan::MemoryTypeAllocator< RHI::MemorySubAllocator< BufferMemoryFreeListSubAllocatorTraits >, BufferMemoryView >, and AZ::Vulkan::MemoryTypeAllocator< RHI::MemorySubAllocator< MemoryFreeListSubAllocatorTraits >, MemoryView >.

Public Member Functions

 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.

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0

Detailed Description

A variant of Object associated with a Device instance. It holds a strong reference to the device and provides a simple accessor API.

Member Function Documentation

Device& AZ::RHI::DeviceObject::GetDevice ( ) const

Returns the device this object is associated with. It is only permitted to call this method when the object is initialized.

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