StructuredBuffer<T, L>.Load

Description

Load a element from the buffer at the specified location.

Signature

/// Requires Capability Set 1:
T StructuredBuffer<T, L>.Load<TIndex>(TIndex location)
    where TIndex : __BuiltinIntegerType
    where L : IBufferDataLayout;

/// Requires Capability Set 2:
T StructuredBuffer<T, L>.Load<TIndex>(
    TIndex location,
    out uint status)
    where TIndex : __BuiltinIntegerType
    where L : IBufferDataLayout;

Generic Parameters

TIndex: __BuiltinIntegerType

Type of the index.

Parameters

location : TIndex

The index of buffer.

status : uint

[out] The status of the operation.

Return value

The element at the specified index.

Remarks

You can’t access the output parameter status directly; instead, pass the status to the CheckAccessFullyMapped intrinsic function. CheckAccessFullyMapped returns TRUE if all values from the corresponding Sample, Gather, or Load operation accessed mapped tiles in a tiled resource. If any values were taken from an unmapped tile, CheckAccessFullyMapped returns FALSE.

Availability and Requirements

Capability Set 1

Defined for the following targets:

hlsl

Available in all stages.

glsl

Available in all stages.

cpp

Available in all stages.

cuda

Available in all stages.

spirv

Available in all stages.

Capability Set 2

Defined for the following targets:

hlsl

Available in all stages.