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.
AZ::Metal::PipelineState Class Referencefinal

Inherits AZ::RHI::PipelineState.

Public Member Functions

 AZ_CLASS_ALLOCATOR (PipelineState, AZ::SystemAllocator)
 
const PipelineLayoutGetPipelineLayout () const
 Returns the type of pipeline state (draw / dispatch).
 
id< MTLRenderPipelineState > GetGraphicsPipelineState () const
 Returns the platform pipeline state object.
 
id< MTLComputePipelineState > GetComputePipelineState () const
 
id< MTLDepthStencilState > GetDepthStencilState () const
 Returns the platform depth stencil state.
 
RasterizerState GetRasterizerState () const
 Returns the platform rasterizer state.
 
MTLPrimitiveType GetPipelineTopology () const
 Returns the Pipeline topology.
 
- Public Member Functions inherited from AZ::RHI::PipelineState
ResultCode Init (Device &device, const PipelineStateDescriptorForDraw &descriptor, PipelineLibrary *pipelineLibrary=nullptr)
 
ResultCode Init (Device &device, const PipelineStateDescriptorForDispatch &descriptor, PipelineLibrary *pipelineLibrary=nullptr)
 
ResultCode Init (Device &device, const PipelineStateDescriptorForRayTracing &descriptor, PipelineLibrary *pipelineLibrary=nullptr)
 
PipelineStateType GetType () const
 
- Public Member Functions inherited from AZ::RHI::DeviceObject
 AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
 
bool IsInitialized () const
 Returns whether the device object is initialized.
 
DeviceGetDevice () 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< PipelineStateCreate ()
 

Public Attributes

RHI::MultisampleState m_pipelineStateMultiSampleState
 Cache multisample state. Used mainly to validate the state against the ove provided by the MSAA image descriptor.
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
void Shutdown () override
 Clears the current bound device to null.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Member Function Documentation

◆ GetPipelineLayout()

const PipelineLayout * AZ::Metal::PipelineState::GetPipelineLayout ( ) const

Returns the type of pipeline state (draw / dispatch).

Returns the pipeline layout associated with this PSO.


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