Skip to content

LiteFX::Rendering::Backends::DirectX12DescriptorSet::bindToHeap

bindToHeap overloads

Synopses

Declared in <litefx/backends/dx12.hpp>

Binds a sampler directly to a descriptor heap and returns the index that can be used to access it.

[[dllimport, dllexport]] virtual UInt32 bindToHeap(
    UInt32 descriptor,
    IDirectX12Sampler const& sampler) const override;

» more...

Binds a sampler directly to a descriptor heap and returns the index that can be used to access it.

[[dllimport]] virtual UInt32 bindToHeap(
    UInt32 descriptor,
    sampler_type const& sampler) const = 0;

» more...

Binds a resource directly to a descriptor heap and returns the index that can be used to access it.

[[dllimport, dllexport]] virtual UInt32 bindToHeap(
    DescriptorType bindingType,
    UInt32 descriptor,
    IDirectX12Buffer const& buffer,
    UInt32 bufferElement = 0,
    UInt32 elements = 0,
    Format texelFormat = Format::None) const override;

» more...

Binds a resource directly to a descriptor heap and returns the index that can be used to access it.

[[dllimport]] virtual UInt32 bindToHeap(
    DescriptorType bindingType,
    UInt32 descriptor,
    buffer_type const& buffer,
    UInt32 bufferElement = 0,
    UInt32 elements = 0,
    Format texelFormat = Format::None) const = 0;

» more...

Binds a resource directly to a descriptor heap and returns the index that can be used to access it.

[[dllimport, dllexport]] virtual UInt32 bindToHeap(
    DescriptorType bindingType,
    UInt32 descriptor,
    IDirectX12Image const& image,
    UInt32 firstLevel = 0,
    UInt32 levels = 0,
    UInt32 firstLayer = 0,
    UInt32 layers = 0) const override;

» more...

Binds a resource directly to a descriptor heap and returns the index that can be used to access it.

[[dllimport]] virtual UInt32 bindToHeap(
    DescriptorType bindingType,
    UInt32 descriptor,
    image_type const& image,
    UInt32 firstLevel = 0,
    UInt32 levels = 0,
    UInt32 firstLayer = 0,
    UInt32 layers = 0) const = 0;

» more...

Return Value

  • The global heap index that can be used to access the sampler from the shader.
  • The global heap index that can be used to access the resource from the shader.

Parameters

NameDescription
descriptorThe index of the descriptor in the heap to bind sampler to.
samplerThe sampler to bind.
bindingTypeThe type of the descriptor used to bind buffer to the heap.
bufferThe buffer to bind.
bufferElementThe index of an element inside buffer that should be bound.
elementsThe number of elements from the buffer to bind to the descriptor set. A value of 0 binds all available elements, starting at bufferElement.
texelFormatThe format used to read a texel buffer. Required if binding binds a texel buffer and ignored otherwise.