Skip to content

LiteFX::Rendering::Backends::DirectX12GraphicsFactory::createIndexBuffer

Creates an index buffer, based on the layout.

Synopsis

Declared in <litefx/backends/dx12.hpp>

[[dllimport, dllexport]] virtual SharedPtr<IDirectX12IndexBuffer> createIndexBuffer(
    String const& name,
    DirectX12IndexBufferLayout const& layout,
    ResourceHeap heap,
    UInt32 elements,
    ResourceUsage usage = ResourceUsage::Default,
    AllocationBehavior allocationBehavior = AllocationBehavior::Default) const override;

Description

An index buffer can be used by different RenderPipeline "RenderPipelines", as long as they share a common input assembler state.

The size of the buffer is computed from the element size index buffer layout, times the number of elements given by the elements parameter.

Return Value

The instance of the index buffer.

Parameters

NameDescription
nameThe name of the buffer.
layoutThe layout of the index buffer.
heapThe heap to allocate the buffer on.
usageThe intended usage for the buffer.
elementsThe number of elements within the vertex buffer (i.e. the number of indices).
allocationBehaviorThe behavior controlling what happens if currently there is not enough memory available for the resource.