C Specification

The xrCaptureSceneAsyncBD function is defined as:

// Provided by XR_BD_spatial_scene
XrResult xrCaptureSceneAsyncBD(
    XrSenseDataProviderBD                       provider,
    const XrSceneCaptureInfoBD*                 info,
    XrFutureEXT*                                future);

Parameters

Parameter Descriptions

Description

The application starts the scene capture process, which guides the user to capture the scene of the physical environment, by calling xrCaptureSceneAsyncBD.

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

Note that scene capture may involve interaction by the user with system user interfaces. After calling this function, the system may switch the current application to the scene capture process. Accordingly, the runtime may emit an XrEventDataSessionStateChanged event with XrEventDataSessionStateChanged::state set to XR_SESSION_STATE_STOPPING, for the application to handle as usual, before scene capture results arrive.

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

See Also

XR_BD_spatial_scene, XrFutureEXT, XrSceneCaptureInfoBD, 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.