LiteFX::Rendering::IPipelineLayout Class Reference

The interface for a pipeline layout. More...

#include <rendering_api.hpp>

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

Public Member Functions
virtual	~IPipelineLayout () noexcept=default
virtual const IDescriptorSetLayout &	descriptorSet (const UInt32 &space) const =0
	Returns the descriptor set layout for the descriptor set that is bound to the space provided by space . More...
Array< const IDescriptorSetLayout * >	descriptorSets () const noexcept
	Returns all descriptor set layouts, the pipeline has been initialized with. More...
virtual const IPushConstantsLayout *	pushConstants () const noexcept=0
	Returns the push constants layout, or nullptr, if the pipeline does not use any push constants. More...

Detailed Description

The interface for a pipeline layout.

Constructor & Destructor Documentation

~IPipelineLayout()

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

virtualdefaultnoexcept

Member Function Documentation

descriptorSet()

virtual const IDescriptorSetLayout & LiteFX::Rendering::IPipelineLayout::descriptorSet ( const 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::PipelineLayout< TDescriptorSetLayout, TPushConstantsLayout >, LiteFX::Rendering::Backends::DirectX12PipelineLayout, LiteFX::Rendering::Backends::VulkanPipelineLayout, LiteFX::Rendering::PipelineLayout< DirectX12DescriptorSetLayout, DirectX12PushConstantsLayout >, and LiteFX::Rendering::PipelineLayout< VulkanDescriptorSetLayout, VulkanPushConstantsLayout >.

descriptorSets()

Array< const IDescriptorSetLayout * > LiteFX::Rendering::IPipelineLayout::descriptorSets ( ) const

inlinenoexcept

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

Returns

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

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 >.