C Specification

The xrEnumeratePersistedAnchorsANDROID function is defined as:

// Provided by XR_ANDROID_device_anchor_persistence
XrResult xrEnumeratePersistedAnchorsANDROID(
    XrDeviceAnchorPersistenceANDROID            handle,
    uint32_t                                    anchorIdCapacityInput,
    uint32_t*                                   anchorIdCountOutput,
    XrUuidEXT*                                  anchorIds);

Parameters

Parameter Descriptions

Description

To enumerate all current persisted anchors, the application calls xrEnumeratePersistedAnchorsANDROID. anchorIds will hold the UUIDs of the persisted anchors up to the capacity of the array. Since anchors are persisted asynchronously, the count of persisted anchors may change in between calls, causing anchorIdCountOutput to differ as well. If the capacity is insufficient, the runtime must truncate the values to fit the output array and makes no guarantees about which anchors are returned. The runtime must return XR_ERROR_PERSISTED_DATA_NOT_READY_ANDROID if the persisted data loading for handle is not yet complete.

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_SIZE_INSUFFICIENT

  • XR_ERROR_PERSISTED_DATA_NOT_READY_ANDROID

See Also

XR_ANDROID_device_anchor_persistence, XrDeviceAnchorPersistenceANDROID, 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.