C Specification

The xrUnpersistSpatialAnchorCompleteBD function is defined as:

// Provided by XR_BD_spatial_anchor
XrResult xrUnpersistSpatialAnchorCompleteBD(
    XrSenseDataProviderBD                       provider,
    XrFutureEXT                                 future,
    XrFutureCompletionEXT*                      completion);

Parameters

Parameter Descriptions

Description

The application obtains the spatial anchor unpersist result using xrUnpersistSpatialAnchorCompleteBD.

This is the completion function corresponding to xrUnpersistSpatialAnchorAsyncBD. It completes the asynchronous operation and returns the results. Do not call until the future is READY.

Future Return Codes

XrFutureCompletionEXT::futureResult values:

Success

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

Failure

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_SPATIAL_ANCHOR_NOT_FOUND_BD

The runtime must set XrFutureCompletionEXT::futureResult to XR_ERROR_SPATIAL_ANCHOR_NOT_FOUND_BD if the spatial anchor is not found in XrSpatialAnchorUnpersistInfoBD::location.

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_SPATIAL_SENSING_SERVICE_UNAVAILABLE_BD

  • XR_ERROR_FUTURE_PENDING_EXT

  • XR_ERROR_FUTURE_INVALID_EXT

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_BD_spatial_anchor, XrFutureCompletionEXT, XrFutureEXT, XrSenseDataProviderBD

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.