Skip to content

LiteFX

LiteFX::Rendering::Backends::VulkanDescriptorSetLayout

`LiteFX::Rendering::Backends::VulkanDescriptorSetLayout`¶

Implements a Vulkan DescriptorSetLayout.

Synopsis¶

Declared in <litefx/backends/vulkan.hpp>

class [[dllimport, dllexport]] VulkanDescriptorSetLayout final
    : public DescriptorSetLayout<VulkanDescriptorLayout, VulkanDescriptorSet>
    , public Resource<VkDescriptorSetLayout>

Base Classes¶

Name	Description
`DescriptorSetLayout<VulkanDescriptorLayout, VulkanDescriptorSet>`	Describes the layout of a descriptor set.
`Resource<VkDescriptorSetLayout>`	Implements the `IResource` interface.

Type Aliases¶

Name
`base_type`
`builder_type`
`descriptor_layout_type`
`descriptor_set_type`
`handle_type`

Member Functions¶

Name	Description
`~VulkanDescriptorSetLayout` [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` [virtual]	Returns the layouts of the descriptors within the descriptor set.
`device`	Returns a reference of the device, the pipeline layout has been created from.
`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.
`handle` [virtual]	Returns the resource managed by the class.
`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.
`maxUnboundedArraySize`	Returns the maximum allowed size for an unbounded array in a descriptor set created with this layout, or `0` if the layout does not contain an unbounded array.
`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.
`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.

Static Member Functions¶

Name	Description
`create`	`create` overloads

Using Declarations¶

Name
`allocate`
`free`

Protected Member Functions¶

Name	Description
`operator=`	Assignment operators
`handle` [virtual]	Returns the resource managed by the class.

Friends¶

Name	Description
`LiteFX::SharedObject::Allocator`	An allocator used to allocate the shared object.
`LiteFX::Rendering::Backends::VulkanDescriptorSetLayoutBuilder`	Builds a `VulkanDescriptorSetLayout` for a `VulkanPipelineLayout`.
`LiteFX::Rendering::Backends::VulkanDescriptorSetLayout::VulkanDescriptorSetLayoutImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.

See Also¶

VulkanDescriptorSet

VulkanDescriptorSetLayoutBuilder