LiteFX::Rendering::IPipelineLayout Class Reference

The interface for a pipeline layout. More...

#include <rendering_api.hpp>

Inherits LiteFX::SharedObject.

Inherited by LiteFX::Rendering::PipelineLayout< DirectX12DescriptorSetLayout, DirectX12PushConstantsLayout >, LiteFX::Rendering::PipelineLayout< VulkanDescriptorSetLayout, VulkanPushConstantsLayout >, and LiteFX::Rendering::PipelineLayout< TDescriptorSetLayout, TPushConstantsLayout >.

Public Member Functions
	~IPipelineLayout () noexcept override=default
virtual const IDescriptorSetLayout &	descriptorSet (UInt32 space) const =0
	Returns the descriptor set layout for the descriptor set that is bound to the space provided by space .
Enumerable< SharedPtr< const IDescriptorSetLayout > >	descriptorSets () const
	Returns all descriptor set layouts, the pipeline has been initialized with.
virtual const IPushConstantsLayout *	pushConstants () const noexcept=0
	Returns the push constants layout, or nullptr, if the pipeline does not use any push constants.
virtual bool	dynamicResourceHeapAccess () const =0
	Returns true, if the pipeline supports directly indexing into a resource heap and false otherwise.
virtual bool	dynamicSamplerHeapAccess () const =0
	Returns true, if the pipeline supports directly indexing into a sampler heap and false otherwise.
Public Member Functions inherited from LiteFX::SharedObject
virtual	~SharedObject () noexcept=default
	Destroys the shared object.
template<typename TSelf>
auto	shared_from_this (this TSelf &&self) noexcept
	Returns a shared pointer to the current object instance.
template<typename TSelf>
auto	weak_from_this (this TSelf &&self) noexcept -> WeakPtr< std::remove_reference_t< TSelf > >
	Returns a weak pointer to the current object instance.

Protected Member Functions
	IPipelineLayout () noexcept=default
	IPipelineLayout (const IPipelineLayout &)=default
	IPipelineLayout (IPipelineLayout &&) noexcept=default
IPipelineLayout &	operator= (const IPipelineLayout &)=default
IPipelineLayout &	operator= (IPipelineLayout &&) noexcept=default
Protected Member Functions inherited from LiteFX::SharedObject
	SharedObject () noexcept=default
	Initializes a new shared object.
	SharedObject (SharedObject &&) noexcept=default
	SharedObject (const SharedObject &)=default
SharedObject &	operator= (SharedObject &&) noexcept=default
SharedObject &	operator= (const SharedObject &)=default

Additional Inherited Members
Static Protected Member Functions inherited from LiteFX::SharedObject
template<typename T, typename... TArgs>
static auto	create (TArgs &&... args) -> SharedPtr< T >
	Generic factory method used to create instances of the shared object.

Detailed Description

The interface for a pipeline layout.

Constructor & Destructor Documentation

IPipelineLayout() [1/3]

LiteFX::Rendering::IPipelineLayout::IPipelineLayout ( )

protecteddefaultnoexcept

IPipelineLayout() [2/3]

LiteFX::Rendering::IPipelineLayout::IPipelineLayout ( const IPipelineLayout & )

protecteddefault

IPipelineLayout() [3/3]

LiteFX::Rendering::IPipelineLayout::IPipelineLayout ( IPipelineLayout && )

protecteddefaultnoexcept

~IPipelineLayout()

LiteFX::Rendering::IPipelineLayout::~IPipelineLayout ( )

overridedefaultnoexcept

Member Function Documentation

descriptorSet()

virtual const IDescriptorSetLayout & LiteFX::Rendering::IPipelineLayout::descriptorSet ( UInt32 space ) const

pure virtual

Returns the descriptor set layout for the descriptor set that is bound to the space provided by space .

Parameters

space

The space to request the descriptor set layout for.

Returns

The descriptor set layout for the descriptor set that is bound to the space provided by space .

Implemented in LiteFX::Rendering::Backends::DirectX12PipelineLayout, LiteFX::Rendering::Backends::VulkanPipelineLayout, LiteFX::Rendering::PipelineLayout< TDescriptorSetLayout, TPushConstantsLayout >, LiteFX::Rendering::PipelineLayout< DirectX12DescriptorSetLayout, DirectX12PushConstantsLayout >, and LiteFX::Rendering::PipelineLayout< VulkanDescriptorSetLayout, VulkanPushConstantsLayout >.

descriptorSets()

Enumerable< SharedPtr< const IDescriptorSetLayout > > LiteFX::Rendering::IPipelineLayout::descriptorSets ( ) const

inline

Returns all descriptor set layouts, the pipeline has been initialized with.

Returns

All descriptor set layouts, the pipeline has been initialized with.

dynamicResourceHeapAccess()

virtual bool LiteFX::Rendering::IPipelineLayout::dynamicResourceHeapAccess ( ) const

pure virtual

Returns true, if the pipeline supports directly indexing into a resource heap and false otherwise.

Returns

true, if the pipeline supports directly indexing into a resource heap and false otherwise

Implemented in LiteFX::Rendering::Backends::DirectX12PipelineLayout, and LiteFX::Rendering::Backends::VulkanPipelineLayout.

dynamicSamplerHeapAccess()

virtual bool LiteFX::Rendering::IPipelineLayout::dynamicSamplerHeapAccess ( ) const

pure virtual

Returns true, if the pipeline supports directly indexing into a sampler heap and false otherwise.

Returns

true, if the pipeline supports directly indexing into a sampler heap and false otherwise

Implemented in LiteFX::Rendering::Backends::DirectX12PipelineLayout, and LiteFX::Rendering::Backends::VulkanPipelineLayout.

operator=() [1/2]

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

protecteddefault

operator=() [2/2]

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

protecteddefaultnoexcept

pushConstants()

virtual const IPushConstantsLayout * LiteFX::Rendering::IPipelineLayout::pushConstants ( ) const

pure virtualnoexcept

Returns the push constants layout, or nullptr, if the pipeline does not use any push constants.

Returns

The push constants layout, or nullptr, if the pipeline does not use any push constants.

Implemented in LiteFX::Rendering::Backends::DirectX12PipelineLayout, LiteFX::Rendering::Backends::VulkanPipelineLayout, LiteFX::Rendering::PipelineLayout< TDescriptorSetLayout, TPushConstantsLayout >, LiteFX::Rendering::PipelineLayout< DirectX12DescriptorSetLayout, DirectX12PushConstantsLayout >, and LiteFX::Rendering::PipelineLayout< VulkanDescriptorSetLayout, VulkanPushConstantsLayout >.