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

#include <PipelineStateDescriptor.h>

Inherits AZ::RHI::PipelineStateDescriptor.

Public Member Functions

 AZ_RTTI (PipelineStateDescriptorForDraw, "{7121C45A-8102-42CE-827D-AB5199701CB2}", PipelineStateDescriptor)
 
bool operator== (const PipelineStateDescriptorForDraw &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.
 
HashValue64 GetHash () const
 Returns the hash of the pipeline state descriptor contents.
 
bool operator== (const PipelineStateDescriptor &rhs) const
 

Public Attributes

ConstPtr< ShaderStageFunction > m_vertexFunction
 [Required] The vertex function to compile.
 
ConstPtr< ShaderStageFunction > m_geometryFunction
 [Optional] The geometry function to compile.
 
ConstPtr< ShaderStageFunction > m_fragmentFunction
 [Required] The fragment function used to compile.
 
InputStreamLayout m_inputStreamLayout
 The input assembly vertex stream layout for the pipeline.
 
RenderAttachmentConfiguration m_renderAttachmentConfiguration
 The render target configuration for the pipeline.
 
RenderStates m_renderStates
 Various render states for the pipeline.
 
- Public Attributes inherited from AZ::RHI::PipelineStateDescriptor
ConstPtr< PipelineLayoutDescriptor > m_pipelineLayoutDescriptor = nullptr
 The pipeline layout describing the shader resource bindings.
 
AZStd::vector< SpecializationConstant > m_specializationData
 Values for specialization constants.
 

Additional Inherited Members

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

Detailed Description

Describes state necessary to build a graphics pipeline state object (PSO). The graphics pipe requires a pipeline layout and the shader byte code descriptor, as well as the fixed-function input assembly stream layout, render target attachment layout, and various render states.

NOTE: This class does not serialize by design. See PipelineStateDescriptorForDispatch for details.

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