LiteFX 0.4.1.2025
Computer Graphics Engine
Loading...
Searching...
No Matches
LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram > Class Template Referenceabstract

Represents a pipeline state. More...

#include <rendering.hpp>

Inherits LiteFX::Rendering::IPipeline, and LiteFX::Rendering::StateResource.

Inherited by LiteFX::Rendering::ComputePipeline< TPipelineLayout, TShaderProgram > [virtual], LiteFX::Rendering::RayTracingPipeline< TPipelineLayout, TShaderProgram > [virtual], and LiteFX::Rendering::RenderPipeline< TPipelineLayout, TShaderProgram, TInputAssembler, TRasterizer > [virtual].

Public Types

using shader_program_type = TShaderProgram
 
using pipeline_layout_type = TPipelineLayout
 

Public Member Functions

 ~Pipeline () noexcept override=default
 
virtual SharedPtr< const shader_program_typeprogram () const noexcept=0
 
virtual SharedPtr< const pipeline_layout_typelayout () const noexcept=0
 
- Public Member Functions inherited from LiteFX::Rendering::IPipeline
 ~IPipeline () noexcept override=default
 
SharedPtr< const IShaderProgramprogram () const noexcept
 Returns the shader program used by the pipeline.
 
SharedPtr< const IPipelineLayoutlayout () const noexcept
 Returns the layout of the render pipeline.
 
- Public Member Functions inherited from LiteFX::Rendering::IStateResource
virtual ~IStateResource () noexcept=default
 Releases the state resource instance.
 
- Public Member Functions inherited from LiteFX::Rendering::StateResource
 ~StateResource () noexcept override
 Releases the state resource instance.
 
const Stringname () const noexcept override
 Returns the name of the resource.
Returns
The name of the resource.

 

Protected Member Functions

 Pipeline () noexcept=default
 
 Pipeline (const Pipeline &)=default
 
 Pipeline (Pipeline &&) noexcept=default
 
Pipelineoperator= (const Pipeline &)=default
 
Pipelineoperator= (Pipeline &&) noexcept=default
 
- Protected Member Functions inherited from LiteFX::Rendering::IPipeline
 IPipeline () noexcept=default
 
 IPipeline (const IPipeline &)=delete
 
 IPipeline (IPipeline &&) noexcept=default
 
IPipelineoperator= (const IPipeline &)=delete
 
IPipelineoperator= (IPipeline &&) noexcept=default
 
- Protected Member Functions inherited from LiteFX::Rendering::IStateResource
 IStateResource () noexcept=default
 
 IStateResource (const IStateResource &)=delete
 
 IStateResource (IStateResource &&) noexcept=default
 
IStateResourceoperator= (const IStateResource &)=delete
 
IStateResourceoperator= (IStateResource &&) noexcept=default
 
- Protected Member Functions inherited from LiteFX::Rendering::StateResource
 StateResource ()
 Initializes a new state resource instance with a default name.
 
 StateResource (StringView name)
 Initializes a new state resource instance.
 
 StateResource (StateResource &&) noexcept
 
StateResourceoperator= (StateResource &&) noexcept
 
 StateResource (const StateResource &)=delete
 
StateResourceoperator= (const StateResource &)=delete
 
Stringname () noexcept
 

Detailed Description

template<typename TPipelineLayout, typename TShaderProgram>
requires meta::implements<TPipelineLayout, PipelineLayout<typename TPipelineLayout::descriptor_set_layout_type, typename TPipelineLayout::push_constants_layout_type>> && meta::implements<TShaderProgram, ShaderProgram<typename TShaderProgram::shader_module_type>>
class LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >

Represents a pipeline state.

Template Parameters
TPipelineLayoutThe type of the render pipeline layout. Must implement PipelineLayout.
TShaderProgramThe type of the shader program. Must implement ShaderProgram.
See also
RenderPipeline, ComputePipeline

Member Typedef Documentation

◆ pipeline_layout_type

template<typename TPipelineLayout , typename TShaderProgram >
using LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::pipeline_layout_type = TPipelineLayout

◆ shader_program_type

template<typename TPipelineLayout , typename TShaderProgram >
using LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::shader_program_type = TShaderProgram

Constructor & Destructor Documentation

◆ Pipeline() [1/3]

template<typename TPipelineLayout , typename TShaderProgram >
LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::Pipeline ( )
protecteddefaultnoexcept

◆ Pipeline() [2/3]

template<typename TPipelineLayout , typename TShaderProgram >
LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::Pipeline ( const Pipeline< TPipelineLayout, TShaderProgram > & )
protecteddefault

◆ Pipeline() [3/3]

template<typename TPipelineLayout , typename TShaderProgram >
LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::Pipeline ( Pipeline< TPipelineLayout, TShaderProgram > && )
protecteddefaultnoexcept

◆ ~Pipeline()

template<typename TPipelineLayout , typename TShaderProgram >
LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::~Pipeline ( )
overridedefaultnoexcept

Member Function Documentation

◆ layout()

◆ operator=() [1/2]

template<typename TPipelineLayout , typename TShaderProgram >
Pipeline & LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::operator= ( const Pipeline< TPipelineLayout, TShaderProgram > & )
protecteddefault

◆ operator=() [2/2]

template<typename TPipelineLayout , typename TShaderProgram >
Pipeline & LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram >::operator= ( Pipeline< TPipelineLayout, TShaderProgram > && )
protecteddefaultnoexcept

◆ program()