Skip to content

LiteFX

LiteFX::Rendering::DescriptorSetLayoutBuilder

`LiteFX::Rendering::DescriptorSetLayoutBuilder`¶

Builds a DescriptorSetLayout for a PipelineLayout.

Synopsis¶

Declared in <litefx/rendering_builders.hpp>

template<
    typename TDescriptorSetLayout,
    typename TParent>
requires meta::implements<TDescriptorSetLayout, DescriptorSetLayout<typename TDescriptorSetLayout::descriptor_layout_type, typename TDescriptorSetLayout::descriptor_set_type>>
class DescriptorSetLayoutBuilder
    : public Builder<TDescriptorSetLayout, TParent, SharedPtr<TDescriptorSetLayout>>

Base Classes¶

Name	Description
`Builder<TDescriptorSetLayout, TParent, SharedPtr<TDescriptorSetLayout>>`	Describes an generic builder type.

Type Aliases¶

Name
`descriptor_layout_type`
`descriptor_set_layout_type`
`descriptor_set_type`
`instance_type`
`parent_type`
`pointer_type`

Member Functions¶

Name	Description
`operator=`	Assignment operators
`add`	First, calls `build`, then `use` on the parent builder using the current object instance and finally returns the parent builder.
`instance`	Returns a pointer to the current instance of the object that is built by the builder.
`parent`	Returns a reference of the parent builder.
`shaderStages`	Sets the shader stages, the descriptor set is accessible from.
`space`	Sets the space, the descriptor set is bound to.
`use`	`use` overloads
`withAccelerationStructure`	Adds a ray-tracing acceleration structure.
`withBuffer`	Adds a texel buffer descriptor.
`withBufferArray`	Adds a texel buffer descriptor array.
`withByteAddressBuffer`	Adds a byte address buffer descriptor.
`withByteAddressBufferArray`	Adds a byte address buffer descriptor array.
`withConstantBuffer`	Adds an uniform/constant buffer descriptor.
`withConstantBufferArray`	Adds an uniform/constant buffer descriptor array.
`withDescriptor`	Adds a descriptor to the descriptor set layout.
`withInputAttachment`	Adds an input attachment descriptor.
`withResourceHeapAccess`	Adds a proxy descriptor that can be used with dynamic resource indexing.
`withSampler`	Adds a sampler descriptor.
`withSamplerArray`	Adds a sampler descriptor.
`withSamplerHeapAccess`	Adds a proxy descriptor that can be used with dynamic sampler indexing.
`withStaticSampler`	Defines a static sampler at the descriptor bound to `binding.`
`withStructuredBuffer`	Adds a storage/structured buffer descriptor.
`withStructuredBufferArray`	Adds a storage/structured buffer descriptor array.
`withTexture`	Adds an image/texture descriptor.
`withTextureArray`	Adds an image/texture descriptor.

Using Declarations¶

Name
`Unnamed using`

Protected Member Functions¶

Name	Description
`build` [virtual]	Can be overwritten to perform any pre-construction work before the builder returns the final object instance.
`instance`	Returns a pointer to the current instance of the object that is built by the builder.
`makeDescriptor`	`makeDescriptor` overloads
`state`	Returns the current descriptor set layout state.

Template Parameters¶

Name	Description
TDescriptorSetLayout	The type of the descriptor set layout. Must implement `DescriptorSetLayout`.

Derived Classes¶

Name	Description
`DirectX12DescriptorSetLayoutBuilder`	Builds a `DirectX12DescriptorSetLayout` for a pipeline layout.
`VulkanDescriptorSetLayoutBuilder`	Builds a `VulkanDescriptorSetLayout` for a `VulkanPipelineLayout`.

See Also¶

DescriptorSetLayout

PipelineLayout