LiteFX::Rendering::IPipeline Class Reference

The interface for a pipeline. More...

#include <rendering_api.hpp>

Inherits LiteFX::Rendering::IStateResource.

Inherited by LiteFX::Rendering::Pipeline< DirectX12PipelineLayout, DirectX12ShaderProgram > [virtual], LiteFX::Rendering::Pipeline< VulkanPipelineLayout, VulkanShaderProgram > [virtual], LiteFX::Rendering::IComputePipeline [virtual], LiteFX::Rendering::IRayTracingPipeline [virtual], LiteFX::Rendering::IRenderPipeline [virtual], and LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram > [virtual].

Public Member Functions
	~IPipeline () noexcept override=default
SharedPtr< const IShaderProgram >	program () const noexcept
	Returns the shader program used by the pipeline.
SharedPtr< const IPipelineLayout >	layout () 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.
virtual const String &	name () const noexcept=0
	Returns the name of the resource.

Protected Member Functions
	IPipeline () noexcept=default
	IPipeline (const IPipeline &)=delete
	IPipeline (IPipeline &&) noexcept=default
IPipeline &	operator= (const IPipeline &)=delete
IPipeline &	operator= (IPipeline &&) noexcept=default
Protected Member Functions inherited from LiteFX::Rendering::IStateResource
	IStateResource () noexcept=default
	IStateResource (const IStateResource &)=delete
	IStateResource (IStateResource &&) noexcept=default
IStateResource &	operator= (const IStateResource &)=delete
IStateResource &	operator= (IStateResource &&) noexcept=default

Detailed Description

The interface for a pipeline.

See also

IComputePipeline, IRenderPipeline, IRayTracingPipeline

Constructor & Destructor Documentation

IPipeline() [1/3]

LiteFX::Rendering::IPipeline::IPipeline ( )

protecteddefaultnoexcept

IPipeline() [2/3]

LiteFX::Rendering::IPipeline::IPipeline ( const IPipeline & )

protecteddelete

IPipeline() [3/3]

LiteFX::Rendering::IPipeline::IPipeline ( IPipeline && )

protecteddefaultnoexcept

~IPipeline()

LiteFX::Rendering::IPipeline::~IPipeline ( )

overridedefaultnoexcept

Member Function Documentation

layout()

SharedPtr< const IPipelineLayout > LiteFX::Rendering::IPipeline::layout ( ) const

inlinenoexcept

Returns the layout of the render pipeline.

Returns

The layout of the render pipeline.

operator=() [1/2]

IPipeline & LiteFX::Rendering::IPipeline::operator= ( const IPipeline & )

protecteddelete

operator=() [2/2]

IPipeline & LiteFX::Rendering::IPipeline::operator= ( IPipeline && )

protecteddefaultnoexcept

program()

SharedPtr< const IShaderProgram > LiteFX::Rendering::IPipeline::program ( ) const

inlinenoexcept

Returns the shader program used by the pipeline.

Returns

The shader program used by the pipeline.