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.
Public Member Functions | Protected Member Functions | List of all members
AZ::RHI::MultiDeviceObject Class Reference

#include <MultiDeviceObject.h>

Inherits AZ::RHI::Object.

Inherited by AZ::RHI::MultiDeviceFence, AZ::RHI::MultiDevicePipelineLibrary, AZ::RHI::MultiDevicePipelineState, AZ::RHI::MultiDeviceResource, and AZ::RHI::MultiDeviceResourcePool.

Public Member Functions

 AZ_RTTI (MultiDeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
 
bool IsInitialized () const
 Returns whether the device object is initialized.
 
MultiDevice::DeviceMask GetDeviceMask () 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 (MultiDevice::DeviceMask deviceMask)
 The derived class should call this method to assign the device.
 
void Shutdown () override
 Clears the current bound device to null.
 
template<typename T >
void IterateDevices (T callback)
 Helper method that will iterate over all selected devices and call the provided callback.
 
- 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 DeviceMask. In contrast to DeviceObject, which is device-specific and holds a strong reference to a specific device, MultiDeviceObject only specifies on which device an object resides/operates, specified by a DeviceMask (1 bit per device).

Member Function Documentation

◆ GetDeviceMask()

MultiDevice::DeviceMask AZ::RHI::MultiDeviceObject::GetDeviceMask ( ) const

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

◆ Shutdown()

void AZ::RHI::MultiDeviceObject::Shutdown ( )
overrideprotectedvirtual

Clears the current bound device to null.

Reimplemented from AZ::RHI::Object.

Reimplemented in AZ::RHI::MultiDeviceQuery, AZ::RHI::MultiDeviceQueryPool, AZ::RHI::MultiDeviceResource, and AZ::RHI::MultiDeviceResourcePool.

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