Open 3D Engine Atom Gem API Reference 25.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 | List of all members
AZ::RHI::PipelineState Class Reference

#include <PipelineState.h>

Inherits AZ::RHI::MultiDeviceObject.

Public Member Functions

 AZ_CLASS_ALLOCATOR (PipelineState, AZ::SystemAllocator, 0)
 
 AZ_RTTI (PipelineState, "77B85640-C2E2-4312-AD67-68FED421F84E", MultiDeviceObject)
 
 AZ_RHI_MULTI_DEVICE_OBJECT_GETTER (PipelineState)
 
ResultCode Init (MultiDevice::DeviceMask deviceMask, const PipelineStateDescriptor &descriptor, PipelineLibrary *pipelineLibrary=nullptr)
 
void PreInitialize (MultiDevice::DeviceMask deviceMask)
 Preinitializes a pipeline state to allow for safe usage with multi-threaded DrawPacket creation.
 
PipelineStateType GetType () const
 
- Public Member Functions inherited from AZ::RHI::MultiDeviceObject
 AZ_RTTI (MultiDeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
 
bool IsInitialized () const
 Returns whether the device object is initialized.
 
AZ_FORCE_INLINE bool IsDeviceSet (int deviceIndex) const
 
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.
 

Additional Inherited Members

- Static Public Member Functions inherited from AZ::RHI::MultiDeviceObject
template<typename T >
static AZ_FORCE_INLINE void IterateDevices (MultiDevice::DeviceMask deviceMask, T callback)
 
- Protected Member Functions inherited from AZ::RHI::MultiDeviceObject
void Init (MultiDevice::DeviceMask deviceMask)
 The derived class should call this method to assign the device.
 
template<typename T >
AZ_FORCE_INLINE void IterateDevices (T callback)
 Helper method that will iterate over all selected devices and call the provided callback.
 
template<typename T , typename U >
AZ_FORCE_INLINE decltype(auto) IterateObjects (U callback)
 
template<typename T , typename U >
AZ_FORCE_INLINE decltype(auto) IterateObjects (U callback) const
 
template<typename T >
AZ_FORCE_INLINE Ptr< T > GetDeviceObject (int deviceIndex) const
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::MultiDeviceObject
AZStd::unordered_map< int, Ptr< DeviceObject > > m_deviceObjects
 A map of all device-specific objects, indexed by the device index.
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Detailed Description

PipelineState is a multi-device class (representing a DevicePipelineState on multiple devices). It holds a map of device-specific DevicePipelineState objects, which can be addressed with a device index. The class is initialized with a device mask (1 bit per device), which initializes one DevicePipelineState for each bit set and stores them in a map. The API then forwards all calls to the all device-specific DevicePipelineState objects by iterating over them and forwarding the call. A device-specific DevicePipelineState can be accessed by calling GetDevicePipelineState with the corresponding device index

Member Function Documentation

◆ Init()

ResultCode AZ::RHI::PipelineState::Init ( MultiDevice::DeviceMask  deviceMask,
const PipelineStateDescriptor &  descriptor,
PipelineLibrary *  pipelineLibrary = nullptr 
)

Initializes a pipeline state (either graphics, compute or ray tracing), associated with the all devices selected in the deviceMask, using the provided descriptor. The initialization call is forwarded to the respective device- and descriptor-specific method.

Parameters
descriptorCan be either PipeLineStateDescriptorForDraw, PipeLineStateDescriptorForDispatch or PipeLineStateDescriptorForRayTracing
pipelineLibraryAn optional pipeline library used to de-duplicate and cache the internal platform pipeline state data, reducing compilation and memory cost. It can be left null.
The documentation for this class was generated from the following file: