Skip to content

LiteFX

LiteFX::Rendering::IDescriptorSetLayout::allocate

`LiteFX::Rendering::IDescriptorSetLayout::allocate`¶

allocate overloads

Synopses¶

Declared in <litefx/rendering_api.hpp>

Allocates a new descriptor set or returns an instance of an unused descriptor set.

[[dllimport, dllexport]] UniquePtr<IDescriptorSet> allocate(Generator<DescriptorBinding const&> bindings) const;

Allocates a new descriptor set or returns an instance of an unused descriptor set.

[[dllimport, dllexport]] UniquePtr<IDescriptorSet> allocate(Span<DescriptorBinding const> bindings) const;

Allocates a new descriptor set or returns an instance of an unused descriptor set.

[[dllimport, dllexport]] UniquePtr<IDescriptorSet> allocate(std::initializer_list<DescriptorBinding> bindings = { }) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] Generator<UniquePtr<IDescriptorSet>> allocate(
    UInt32 descriptorSets,
    std::function<Generator<DescriptorBinding const&>(UInt32)> bindingFactory) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] Generator<UniquePtr<IDescriptorSet>> allocate(
    UInt32 descriptorSets,
    std::initializer_list<std::initializer_list<DescriptorBinding>> bindings = { }) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] Generator<UniquePtr<IDescriptorSet>> allocate(
    UInt32 descriptorSets,
    std::mdspan<DescriptorBinding const, std::dextents<size_t, 2>> bindings) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] UniquePtr<IDescriptorSet> allocate(
    UInt32 unboundedArraySize,
    Generator<DescriptorBinding const&> bindings) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] UniquePtr<IDescriptorSet> allocate(
    UInt32 unboundedArraySize,
    Span<DescriptorBinding const> bindings) const;

Allocates a new descriptor set or returns an instance of an unused descriptor set.

[[dllimport, dllexport]] UniquePtr<IDescriptorSet> allocate(
    UInt32 unboundedArraySize,
    std::initializer_list<DescriptorBinding> bindings) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] Generator<UniquePtr<IDescriptorSet>> allocate(
    UInt32 descriptorSets,
    UInt32 unboundedArraySize,
    std::function<Generator<DescriptorBinding const&>(UInt32)> bindingFactory) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] Generator<UniquePtr<IDescriptorSet>> allocate(
    UInt32 descriptorSets,
    UInt32 unboundedArraySize,
    std::initializer_list<std::initializer_list<DescriptorBinding>> bindings = { }) const;

Allocates an array of descriptor sets.

[[dllimport, dllexport]] Generator<UniquePtr<IDescriptorSet>> allocate(
    UInt32 descriptorSets,
    UInt32 unboundedArraySize,
    std::mdspan<DescriptorBinding const, std::dextents<size_t, 2>> bindings) const;

Return Value¶

The instance of the descriptor set.
A generator that produces the descriptor set instances.

Parameters¶

Name	Description
bindings	Optional default bindings for descriptors in the descriptor set.
descriptorSets	The number of descriptor sets to allocate.
bindingFactory	A factory function that is called for each descriptor in each descriptor set in order to provide the default bindings.
unboundedArraySize	The number of descriptors to allocate in an unbounded descriptor array. Ignored, if the descriptor set does not contain an unbounded array.

See Also¶

IDescriptorLayout

allocate(std::initializer_list)

IDescriptorLayout

allocate(std::initializer_list)