Skip to content

LiteFX::Rendering::DescriptorBinding

Describes how a resource is bound to one or more descriptors.

Synopsis

Declared in <litefx/rendering_api.hpp>

struct [[dllimport, dllexport]] DescriptorBinding;

Type Aliases

Member Functions

NameDescription
at Returns a copy of the binding, targeting the descriptor range at binding point bindingPoint.
toDescriptor Returns a copy of the binding, starting at descriptor descriptor. This is only required for descriptor arrays where you don't want to start binding at the first descriptor in the array. Specify the binding point by calling at. If it is not set, the index of the array element provided to the binding function will be used instead.

Static Member Functions

NameDescription
accelerationStructure Creates a descriptor binding for an acceleration structure.
byteAddressBuffer Creates a descriptor binding for a byte address buffer.
constantBuffer Creates a descriptor binding for a constant/uniform buffer.
inputAttachment Creates a descriptor binding for an input attachment.
sampler Creates a descriptor binding for a sampler state.
structuredBuffer Creates a descriptor binding for a structured buffer.
texelBuffer Creates a descriptor binding for a texel buffer.
texture Creates a descriptor binding for an image.
writableTexture Creates a descriptor binding for a writable image.

Data Members

NameDescription
binding The binding point to bind the resource at. If not provided (i.e., std::nullopt), the index within the collection of DescriptorBindings is used.
elements The number of array elements or image layers to bind, starting at firstDescriptor.
elementsPerDescriptor The number of consecutive buffer elements viewed by each descriptor.
firstDescriptor The index of the descriptor in a descriptor array at which binding the resource arrays starts.
firstElement The index of the first array element or image layer to bind, starting at firstDescriptor.
firstLevel If the resource is an image, this describes the first level to be bound.
levels If the resource is an image, this describes the number of levels to be bound.
resource The resource to bind or std::monostate if no resource should be bound.
stride The stride of a structure in a structured buffer.
texelFormat The format for a texel in a texel buffer.

See Also

IDescriptorSet

IDescriptorSetLayout

IDescriptorRange