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 | Public Attributes | List of all members
AZ::RHI::PipelineStateDescriptorForDispatch Class Referencefinal

#include <PipelineStateDescriptor.h>

Inherits AZ::RHI::PipelineStateDescriptor.

Public Member Functions

 AZ_RTTI (PipelineStateDescriptorForDispatch, "{78E775AD-DCA8-4408-9A42-CF78DEB1E640}", PipelineStateDescriptor)
 
HashValue64 GetHash () const override
 Computes the hash value for this descriptor.
 
bool operator== (const PipelineStateDescriptorForDispatch &rhs) const
 
- Public Member Functions inherited from AZ::RHI::PipelineStateDescriptor
 AZ_RTTI (PipelineStateDescriptor, "{B334AE47-53CB-438C-B799-DCA542FF8D5D}")
 
PipelineStateType GetType () const
 Returns the derived pipeline state type.
 
virtual HashValue64 GetHash () const =0
 Returns the hash of the pipeline state descriptor contents.
 
bool operator== (const PipelineStateDescriptor &rhs) const
 

Public Attributes

ConstPtr< ShaderStageFunction > m_computeFunction
 The compute function containing byte code to compile.
 
- Public Attributes inherited from AZ::RHI::PipelineStateDescriptor
ConstPtr< PipelineLayoutDescriptor > m_pipelineLayoutDescriptor = nullptr
 The pipeline layout describing the shader resource bindings.
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::PipelineStateDescriptor
 PipelineStateDescriptor (PipelineStateType pipelineStateType)
 

Detailed Description

Describes state necessary to build a compute pipeline state object. The compute pipe requires a pipeline layout and the shader byte code descriptor. Call Finalize after assigning data to build the hash value.

NOTE: This class does not serialize. This is by design. the pipeline layout and shader byte code is likely shared by many PSOs and the serialization system would simply duplicate all of that data. However, the individual pieces are serializable, so a higher-level system could easily construct a PSO library.

Member Function Documentation

◆ GetHash()

HashValue64 AZ::RHI::PipelineStateDescriptorForDispatch::GetHash ( ) const
overridevirtual

Computes the hash value for this descriptor.

Implements AZ::RHI::PipelineStateDescriptor.

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