Skip to content

LiteFX

LiteFX::Rendering::IDescriptorSetLayout

`LiteFX::Rendering::IDescriptorSetLayout`¶

The interface for a descriptor set layout.

Synopsis¶

Declared in <litefx/rendering_api.hpp>

class [[dllimport, dllexport]] IDescriptorSetLayout
    : public SharedObject

Base Classes¶

Name	Description
`SharedObject`	Base class for an object that can be shared.

Type Aliases¶

Name
`_Esft_type`

Member Functions¶

Name	Description
`~IDescriptorSetLayout` [destructor] [virtual]	Destructor
`allocate`	`allocate` overloads
`bindsResources` [virtual]	Returns `true` if the descriptor set layout contains bindings for resources (i.e., bindings that aren't samplers) and `false` otherwise.
`bindsSamplers` [virtual]	Returns `true` if the descriptor set layout contains bindings for samplers and `false` otherwise.
`buffers` [virtual]	Returns the number of texel buffer descriptors within the descriptor set.
`containsUnboundedArray` [virtual]	Returns `true`, if the descriptor set layout contains an unbounded runtime array and `false` otherwise.
`descriptor` [virtual]	Returns the descriptor layout for the descriptor bound to the binding point provided with `binding.`
`descriptors`	Returns the layouts of the descriptors within the descriptor set.
`free`	Marks a descriptor set as unused, so that it can be handed out again instead of allocating a new one.
`getDescriptorOffset` [virtual]	Returns the offset for a descriptor within a descriptor set of this layout.
`images` [virtual]	Returns the number of image (i.e. texture) descriptors within the descriptor set.
`inputAttachments` [virtual]	Returns the number of input attachment descriptors within the descriptor set.
`samplers` [virtual]	Returns the number of dynamic sampler descriptors within the descriptor set.
`shaderStages` [virtual]	Returns the shader stages, the descriptor set is used in.
`shared_from_this`	Returns a shared pointer to the current object instance.
`space` [virtual]	Returns the space index of the descriptor set.
`staticSamplers` [virtual]	Returns the number of static or immutable sampler descriptors within the descriptor set.
`storages` [virtual]	Returns the number of structured and byte address buffer descriptors within the descriptor set.
`uniforms` [virtual]	Returns the number of uniform/constant buffer descriptors within the descriptor set.
`weak_from_this`	Returns a weak pointer to the current object instance.

Protected Types¶

Name	Description
`Allocator`	An allocator used to allocate the shared object.

Protected Member Functions¶

Name	Description
`IDescriptorSetLayout` [constructor]	Constructors
`operator=`	Assignment operators

Protected Static Member Functions¶

Name	Description
`create`	Generic factory method used to create instances of the shared object.

Derived Classes¶

Name	Description
`DescriptorSetLayout`	Describes the layout of a descriptor set.