C Specification

The xrGetSpatialAnchorStateML function is defined as:

// Provided by XR_ML_spatial_anchors
XrResult xrGetSpatialAnchorStateML(
    XrSpace                                     anchor,
    XrSpatialAnchorStateML*                     state);

Parameters

Parameter Descriptions

  • anchor is a handle to an XrSpace corresponding to a spatial anchor.

  • state is a pointer to an XrSpatialAnchorStateML structure to populate with the spatial anchor state.

Description

The runtime must return XR_ERROR_VALIDATION_FAILURE if the XrSpace is not an spatial anchor.

Valid Usage (Implicit)
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_LIMIT_REACHED

See Also

XR_ML_spatial_anchors, XrCreateSpatialAnchorsCompletionML, XrSpace, XrSpatialAnchorStateML, xrCreateSpatialAnchorsAsyncML

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

Copyright 2014-2025 The Khronos Group Inc.

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