Skip to content

LiteFX::Rendering::IGraphicsFactory::tryCreateBuffer

Tries to create a buffer that can be bound to a specific descriptor.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, dllexport]] bool tryCreateBuffer(
    SharedPtr<IBuffer>& buffer,
    String const& name,
    IDescriptorSetLayout const& descriptorSet,
    UInt32 binding,
    ResourceHeap heap,
    UInt32 elements = 1,
    ResourceUsage usage = ResourceUsage::Default,
    AllocationBehavior allocationBehavior = AllocationBehavior::Default) const;

Return Value

true, if the buffer was created successfully and false otherwise.

Parameters

NameDescription
bufferThe instance of the buffer, or nullptr, if the buffer could not be allocated.
nameThe name of the buffer.
descriptorSetThe layout of the descriptors parent descriptor set.
bindingThe binding point of the descriptor within the parent descriptor set.
heapThe heap to allocate the buffer on.
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.