C Specification

The xrCreateSpatialAnchorSpaceANDROID function is defined as:

// Provided by XR_ANDROID_spatial_anchor_space
XrResult xrCreateSpatialAnchorSpaceANDROID(
    XrSession                                   session,
    XrSpatialContextEXT                         spatialContext,
    const XrSpatialAnchorCreateInfoEXT*         createInfo,
    XrSpatialEntityIdEXT*                       anchorEntityId,
    XrSpace*                                    anchorSpace);

Parameters

Parameter Descriptions

Description

The xrCreateSpatialAnchorSpaceANDROID function creates an anchor that outputs an XrSpatialEntityIdEXT and an XrSpace handle. xrCreateSpatialAnchorSpaceANDROID has the same validation requirements as xrCreateSpatialAnchorEXT.

Runtime must return XR_ERROR_VALIDATION_FAILURE if the XrSpatialContextEXT passed to xrCreateSpatialAnchorSpaceANDROID was not configured with XR_SPATIAL_CAPABILITY_ANCHOR_EXT.

With respect to the discoverability of the created anchor by xrCreateSpatialAnchorSpaceANDROID, the last paragraph of the xrCreateSpatialAnchorEXT spec applies.

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_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_LIMIT_REACHED

  • XR_ERROR_OUT_OF_MEMORY

  • XR_ERROR_POSE_INVALID

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_SPATIAL_ANCHOR_ATTACHABLE_COMPONENT_NOT_FOUND_ANDROID

  • XR_ERROR_SPATIAL_ENTITY_ID_INVALID_EXT

  • XR_ERROR_TIME_INVALID

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_ANDROID_spatial_anchor_space, XrSession, XrSpace, XrSpatialAnchorCreateInfoEXT, XrSpatialContextEXT, XrSpatialEntityIdEXT, xrCreateSpatialAnchorEXT

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-2026 The Khronos Group Inc.

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