C Specification

The xrGetAnchorPersistStateANDROID function is defined as:

// Provided by XR_ANDROID_device_anchor_persistence
XrResult xrGetAnchorPersistStateANDROID(
    XrDeviceAnchorPersistenceANDROID            handle,
    const XrUuidEXT*                            anchorId,
    XrAnchorPersistStateANDROID*                persistState);

Parameters

Parameter Descriptions

Description

  • The runtime must set persistState to XR_ANCHOR_PERSIST_STATE_PERSIST_NOT_REQUESTED_ANDROID if the anchor XrUuidEXT has not been requested for persistence.

  • The runtime must return XR_ERROR_PERSISTED_DATA_NOT_READY_ANDROID if the persisted data of anchorId is not ready.

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_PERSISTED_DATA_NOT_READY_ANDROID

  • XR_ERROR_ANCHOR_ID_NOT_FOUND_ANDROID

See Also

XR_ANDROID_device_anchor_persistence, XrAnchorPersistStateANDROID, XrDeviceAnchorPersistenceANDROID, XrUuidEXT, xrPersistAnchorANDROID

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.