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.
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AZ::Vulkan::Pipeline Class Referenceabstract

Inherits AZ::RHI::DeviceObject.

Inherited by AZ::Vulkan::ComputePipeline, AZ::Vulkan::GraphicsPipeline, and AZ::Vulkan::RayTracingPipeline.

Classes

struct  Descriptor
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (Pipeline, AZ::ThreadPoolAllocator)
 
 AZ_RTTI (Pipeline, "A5FCFA0C-D5B3-4833-A572-BCE8FB612C13", Base)
 
RHI::ResultCode Init (const Descriptor &descriptor)
 
PipelineLayout * GetPipelineLayout () const
 
PipelineLibrary * GetPipelineLibrary () const
 
VkPipeline GetNativePipeline () 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.
 
Device & GetDevice () 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

virtual RHI::PipelineStateType GetType ()=0
 
void Shutdown () override
 Clears the current bound device to null.
 
VkPipeline & GetNativePipelineRef ()
 
void FillPipelineShaderStageCreateInfo (const ShaderStageFunction &function, RHI::ShaderStage stage, uint32_t subStageIndex, VkPipelineShaderStageCreateInfo &createInfo)
 
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 

Protected Attributes

PipelineLibrary * m_pipelineLibrary
 
RHI::Ptr< PipelineLayout > m_pipelineLayout
 
AZStd::list< RHI::Ptr< ShaderModule > > m_shaderModules
 
VkPipeline m_nativePipeline = VK_NULL_HANDLE
 
SpecializationConstantData m_specializationConstantData
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Member Function Documentation

◆ Shutdown()

void AZ::Vulkan::Pipeline::Shutdown ( )
overrideprotectedvirtual

Clears the current bound device to null.

Reimplemented from AZ::RHI::DeviceObject.

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