C Specification

The xrPersistAnchorANDROID function is defined as:

// Provided by XR_ANDROID_device_anchor_persistence
XrResult xrPersistAnchorANDROID(
    XrDeviceAnchorPersistenceANDROID            handle,
    const XrPersistedAnchorSpaceInfoANDROID*    persistedInfo,
    XrUuidEXT*                                  anchorIdOutput);

Parameters

Parameter Descriptions

Description

The application requests anchors to be persisted by calling xrPersistAnchorANDROID. The application must not assume a success return value means the anchor is immediately persisted. The application should use xrGetAnchorPersistStateANDROID to check the persist state of the anchor using the returned anchor XrUuidEXT.

  • 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_SUCCESS once the anchor has been queued for persistence.

To unpersist the anchor, the application calls xrUnpersistAnchorANDROID.

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_NOT_TRACKING_ANDROID

  • XR_ERROR_ANCHOR_NOT_OWNED_BY_CALLER_ANDROID

See Also

XR_ANDROID_device_anchor_persistence, XrDeviceAnchorPersistenceANDROID, XrPersistedAnchorSpaceInfoANDROID, XrUuidEXT

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.