C Specification

The xrStartSenseDataProviderCompleteBD function is defined as:

// Provided by XR_BD_spatial_sensing
XrResult xrStartSenseDataProviderCompleteBD(
    XrSession                                   session,
    XrFutureEXT                                 future,
    XrFutureCompletionEXT*                      completion);

Parameters

Parameter Descriptions

Description

The application can obtain the sense data provider start result using xrStartSenseDataProviderCompleteBD.

This is the completion function corresponding to the operation started by xrStartSenseDataProviderAsyncBD. 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_OUT_OF_MEMORY

  • XR_ERROR_PERMISSION_INSUFFICIENT

Subsequent application operations using this handle must not be performed unless the XrFutureCompletionEXT::futureResult is XR_SUCCESS. For example, if the XrFutureCompletionEXT::futureResult is XR_ERROR_PERMISSION_INSUFFICIENT, it indicates that the application does not have sufficient permissions and needs to apply for the corresponding permissions.

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_sensing, XrFutureCompletionEXT, XrFutureEXT, XrSession

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.