C Specification

The xrQuerySenseDataAsyncBD function is defined as:

// Provided by XR_BD_spatial_sensing
XrResult xrQuerySenseDataAsyncBD(
    XrSenseDataProviderBD                       provider,
    const XrSenseDataQueryInfoBD*               queryInfo,
    XrFutureEXT*                                future);

Parameters

Parameter Descriptions

The application can query a sense data provider by calling xrQuerySenseDataAsyncBD.

Description

The application must not call this function to initiate a query request for the spatial sense data unless the xrStartSenseDataProviderCompleteBD has been called successfully, the future completed, and returned a future result of XR_SUCCESS. Otherwise, the runtime must return XR_ERROR_CALL_ORDER_INVALID. The query result is a snapshot of the sense data from the current sense data provider.

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 xrQuerySenseDataCompleteBD, usable when a future from this function is in the READY state, with outputs populated by that function in the completion structure XrSenseDataQueryCompletionBD.

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_FEATURE_UNSUPPORTED

  • XR_ERROR_CALL_ORDER_INVALID

See Also

XR_BD_spatial_sensing, XrFutureEXT, XrSenseDataProviderBD, XrSenseDataQueryInfoBD

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.