C Specification

The xrCreateSpatialAnchorAsyncBD function is defined as:

// Provided by XR_BD_spatial_anchor
XrResult xrCreateSpatialAnchorAsyncBD(
    XrSenseDataProviderBD                       provider,
    const XrSpatialAnchorCreateInfoBD*          info,
    XrFutureEXT*                                future);

Parameters

Parameter Descriptions

An application creates a spatial anchor by calling this function.

Description

This function starts an asynchronous operation and creates a corresponding XrFutureEXT, usable with xrPollFutureEXT and related functions. The return value of this function only indicates whether the parameters were acceptable to schedule the asynchronous operation. The corresponding completion function is xrCreateSpatialAnchorCompleteBD, usable when a future from this function is in the READY state, with outputs populated by that function in the completion structure XrSpatialAnchorCreateCompletionBD.

If the provider was not created with the XrSenseDataProviderTypeBD value XR_SENSE_DATA_PROVIDER_TYPE_ANCHOR_BD, the function xrCreateSpatialAnchorAsyncBD must return XR_ERROR_VALIDATION_FAILURE.

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_TIME_INVALID

  • XR_ERROR_SPATIAL_SENSING_SERVICE_UNAVAILABLE_BD

  • XR_ERROR_POSE_INVALID

  • XR_ERROR_FEATURE_UNSUPPORTED

  • XR_ERROR_CALL_ORDER_INVALID

See Also

XR_BD_spatial_anchor, XrFutureEXT, XrSenseDataProviderBD, XrSpatialAnchorCreateInfoBD

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.