Skip to content

LiteFX::Rendering::IGraphicsFactory::createBuffer

Creates a buffer that can be bound to a descriptor of a specific descriptor set.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, dllexport]] SharedPtr<IBuffer> createBuffer(
    String const& name,
    IPipeline const& pipeline,
    UInt32 space,
    UInt32 binding,
    ResourceHeap heap,
    size_t elementSize,
    UInt32 elements = 1,
    ResourceUsage usage = ResourceUsage::Default,
    AllocationBehavior allocationBehavior = AllocationBehavior::Default) const;

Return Value

The instance of the buffer.

Parameters

NameDescription
nameThe name of the buffer.
pipelineThe pipeline that provides the descriptor set.
spaceThe space, the descriptor set is bound to.
bindingThe binding point of the descriptor within the parent descriptor set.
heapThe heap to allocate the buffer on.
elementSizeThe size of an element in the buffer (in bytes).
elementsThe number of elements in the buffer (in case the buffer is an array).
usageThe intended usage for the buffer.
allocationBehaviorThe behavior controlling what happens if currently there is not enough memory available for the resource.