LiteFX::Rendering::GlobalDescriptorHeaps::allocate

Allocates descriptors from heap.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, nodiscard, dllexport]] DescriptorHeapAllocation allocate(
    DescriptorHeapType heap,
    UInt32 descriptors);

Exceptions

Name	Thrown on
ArgumentOutOfRangeException	Thrown if descriptors is 0.
RuntimeException	Thrown if the descriptor heap is out of space.

Return Value

The allocation for the descriptors.

Note

The return value should not be discarded.

Parameters

Name	Description
heap	The heap to allocate from.
descriptors	The number of descriptors to allocate from heap.