C Specification

The xrCreateGeospatialAnchorANDROID function is defined as:

// Provided by XR_ANDROID_geospatial_anchor
XrResult xrCreateGeospatialAnchorANDROID(
    XrSpatialContextEXT                         spatialContext,
    const XrGeospatialAnchorCreateInfoANDROID*  createInfo,
    XrSpatialEntityIdEXT*                       anchorEntityId);

Parameters

Parameter Descriptions

  • spatialContext is the XrSpatialContextEXT to create the anchor in. The context must be configured for XR_SPATIAL_CAPABILITY_ANCHOR_EXT otherwise the runtime must return XR_ERROR_VALIDATION_FAILURE.

  • createInfo is a pointer to XrGeospatialAnchorCreateInfoANDROID containing anchor creation parameters.

  • anchorEntityId is a pointer to XrSpatialEntityIdEXT in which the anchor entity ID is returned.

Description

If the XrGeospatialTrackerANDROID specified in XrGeospatialAnchorCreateInfoANDROID::geospatialTracker is not in the XR_GEOSPATIAL_TRACKER_STATE_RUNNING_ANDROID state, the runtime must return XR_ERROR_GEOSPATIAL_TRACKER_NOT_RUNNING_ANDROID.

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_GEOSPATIAL_COORDINATES_INVALID_ANDROID

  • XR_ERROR_GEOSPATIAL_TRACKER_NOT_RUNNING_ANDROID

  • 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_VALIDATION_FAILURE

See Also

XR_ANDROID_geospatial_anchor, XrGeospatialAnchorCreateInfoANDROID, XrSpatialContextEXT, XrSpatialEntityIdEXT

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.