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

Inherits AZ::RHI::Device.

Public Member Functions

 AZ_CLASS_ALLOCATOR (Device, AZ::SystemAllocator)
 
 AZ_RTTI (Device,"{F2AAE1EA-6B35-4870-9C73-8CD7EDC149A8}", Base)
 
- 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 PhysicalDevice & GetPhysicalDevice () const
 Returns the physical device associated with this device.
 
int GetDeviceIndex () const
 Returns the device index.
 
const DeviceDescriptor & GetDescriptor () const
 Returns the descriptor associated with the device.
 
const DeviceFeatures & GetFeatures () const
 Returns the set of features supported by this device.
 
const DeviceLimits & GetLimits () const
 Returns the set of hardware limits for this device.
 
const ResourcePoolDatabase & GetResourcePoolDatabase () const
 Returns the resource pool database.
 
ResourcePoolDatabase & GetResourcePoolDatabase ()
 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.
 
virtual AZStd::vector< Format > GetValidSwapChainImageFormats (const WindowHandle &windowHandle) const
 
virtual AZStd::chrono::microseconds GpuTimestampToMicroseconds (uint64_t gpuTimestamp, HardwareQueueClass queueClass) const =0
 Converts a GPU timestamp to microseconds.
 
virtual ResourceMemoryRequirements GetResourceMemoryRequirements (const ImageDescriptor &descriptor)=0
 Get the memory requirements for allocating an image resource.
 
virtual ResourceMemoryRequirements GetResourceMemoryRequirements (const BufferDescriptor &descriptor)=0
 Get the memory requirements for allocating a buffer resource.
 
virtual RHI::ResultCode CompactSRGMemory ()
 Allows the back-ends to compact SRG related memory if applicable.
 
bool WasDeviceRemoved ()
 
void SetDeviceRemoved ()
 
void SetLastExecutingScope (const AZStd::string_view scopeName)
 
AZStd::string_view GetLastExecutingScope () 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< Device > Create ()
 

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
 
The documentation for this class was generated from the following file: