C Specification

The xrDestroySenseDataSnapshotBD function is defined as:

// Provided by XR_BD_spatial_sensing
XrResult xrDestroySenseDataSnapshotBD(
    XrSenseDataSnapshotBD                       snapshot);

Parameters

Parameter Descriptions

The application can destroy a sense data snapshot using xrDestroySenseDataSnapshotBD.

Description

After all the spatial entity info are retrieved from the snapshot, application should destroy the XrSenseDataSnapshotBD handle to release related resources. The runtime may have an upper limit on the number of snapshots it supports. When the application exceeds the runtime’s limit, the runtime must set XrSenseDataQueryCompletionBD::futureResult to XR_ERROR_LIMIT_REACHED when xrQuerySenseDataCompleteBD is called. To obtain new snapshots once the limit is reached, destroy at least one of the previously obtained snapshots.

Valid Usage (Implicit)
Thread Safety

  • Access to snapshot, and any child handles, must be externally synchronized

Return Codes
On success, this command returns

  • XR_SUCCESS

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_SPATIAL_SENSING_SERVICE_UNAVAILABLE_BD

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_BD_spatial_sensing, XrSenseDataSnapshotBD

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.