C Specification

The xrCreatePersistedAnchorSpaceANDROID function is defined as:

// Provided by XR_ANDROID_device_anchor_persistence
XrResult xrCreatePersistedAnchorSpaceANDROID(
    XrDeviceAnchorPersistenceANDROID            handle,
    const XrPersistedAnchorSpaceCreateInfoANDROID* createInfo,
    XrSpace*                                    anchorOutput);

Parameters

Parameter Descriptions

Description

The application creates an XrSpace anchor from a previously persisted anchor by calling xrCreatePersistedAnchorSpaceANDROID with the same XrUuidEXT. This is another way of creating anchors as defined in XR_ANDROID_trackables.

  • The runtime must return XR_ERROR_PERSISTED_DATA_NOT_READY_ANDROID if the persisted data loading for handle is not yet complete.

  • The runtime must return XR_ERROR_ANCHOR_ID_NOT_FOUND_ANDROID if the anchor XrUuidEXT is not found.

  • If the XrUuidEXT refers to an anchor that has not reached the XR_ANCHOR_PERSIST_STATE_PERSISTED_ANDROID state yet, the runtime must return XR_ERROR_ANCHOR_ID_NOT_FOUND_ANDROID.

  • Despite the first parameter of this function being an XrDeviceAnchorPersistenceANDROID, the parent of the created XrSpace is the XrSession that is the parent of handle. The runtime must track the anchor until anchorOutput is destroyed.

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

  • XR_ERROR_PERSISTED_DATA_NOT_READY_ANDROID

  • XR_ERROR_ANCHOR_ID_NOT_FOUND_ANDROID

See Also

XR_ANDROID_device_anchor_persistence, XrDeviceAnchorPersistenceANDROID, XrDeviceAnchorPersistenceCreateInfoANDROID, XrPersistedAnchorSpaceCreateInfoANDROID, XrSpace

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.