C Specification

The xrDownloadSharedSpatialAnchorCompleteBD function is defined as:

// Provided by XR_BD_spatial_anchor_sharing
XrResult xrDownloadSharedSpatialAnchorCompleteBD(
    XrSenseDataProviderBD                       provider,
    XrFutureEXT                                 future,
    XrFutureCompletionEXT*                      completion);

Parameters

Parameter Descriptions

The application obtains the spatial anchor download result using xrDownloadSharedSpatialAnchorCompleteBD.

Description

This is the completion function corresponding to the operation started by xrDownloadSharedSpatialAnchorAsyncBD. Do not call until the future is READY.

The XrFutureCompletionEXT structure is defined in XR_EXT_future.

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_PERMISSION_INSUFFICIENT

If the spatial anchor is downloaded to the local device, the runtime must set the XrFutureCompletionEXT::futureResult value to XR_SUCCESS. This indicates that the spatial anchor has been successfully downloaded to the local device and located. To obtain the spatial anchors from the spatial anchor data provider, call xrQuerySenseDataAsyncBD, xrQuerySenseDataCompleteBD, xrGetQueriedSenseDataBD, and xrCreateSpatialEntityAnchorBD. All of these functions are defined in XR_BD_spatial_sensing.

Note
Note

It is implementation defined whether the runtime implements permission controls, in which case it may set XrFutureCompletionEXT::futureResult to XR_ERROR_PERMISSION_INSUFFICIENT when attempting to download an anchor without permission.
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_sharing, 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.