xrGetSpatialBufferVector2fEXT(3)

C Specification

The xrGetSpatialBufferVector2fEXT function is defined as:

// Provided by XR_EXT_spatial_entity
XrResult xrGetSpatialBufferVector2fEXT(
    XrSpatialSnapshotEXT                        snapshot,
    const XrSpatialBufferGetInfoEXT*            info,
    uint32_t                                    bufferCapacityInput,
    uint32_t*                                   bufferCountOutput,
    XrVector2f*                                 buffer);

Parameters

Parameter Descriptions

snapshot is a handle to an XrSpatialSnapshotEXT.
info holds the information on the buffer to query.
bufferCapacityInput is the capacity of the array, or 0 to indicate a request to retrieve the required capacity.
bufferCountOutput is the number of elements in the buffer array, or the required capacity in the case that bufferCapacityInput is insufficient.
buffer is an array of XrVector2f. It can be NULL if bufferCapacityInput is 0.
See the https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#fundamentals-buffer-size-parameters section for a detailed description of retrieving the required buffer size.

Description

The application can get the data for an XrSpatialBufferEXT provided by a component, where XrSpatialBufferEXT::bufferType is XR_SPATIAL_BUFFER_TYPE_VECTOR2F_EXT by using xrGetSpatialBufferVector2fEXT.

The runtime must return XR_ERROR_VALIDATION_FAILURE if the XrSpatialBufferTypeEXT for XrSpatialBufferGetInfoEXT::bufferId is not XR_SPATIAL_BUFFER_TYPE_VECTOR2F_EXT.

The runtime must return XR_ERROR_SPATIAL_BUFFER_ID_INVALID_EXT if XrSpatialBufferGetInfoEXT::bufferId does not belong to snapshot.

Valid Usage (Implicit)

The XR_EXT_spatial_entity extension must be enabled prior to calling xrGetSpatialBufferVector2fEXT
snapshot must be a valid XrSpatialSnapshotEXT handle
info must be a pointer to a valid XrSpatialBufferGetInfoEXT structure
bufferCountOutput must be a pointer to a uint32_t value
If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput XrVector2f structures

Return Codes

On success, this command returns

XR_SUCCESS
XR_SESSION_LOSS_PENDING

On failure, this command returns

XR_ERROR_FUNCTION_UNSUPPORTED
XR_ERROR_VALIDATION_FAILURE
XR_ERROR_RUNTIME_FAILURE
XR_ERROR_HANDLE_INVALID
XR_ERROR_INSTANCE_LOST
XR_ERROR_SESSION_LOST
XR_ERROR_OUT_OF_MEMORY
XR_ERROR_SIZE_INSUFFICIENT
XR_ERROR_SPATIAL_BUFFER_ID_INVALID_EXT

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

This work is licensed under a Creative Commons Attribution 4.0 International License.

xrGetSpatialBufferVector2fEXT(3) Manual Page

Name

C Specification

Parameters

Description

See Also

Document Notes

Copyright