C Specification

The xrGetSpatialEntityUuidBD function is defined as:

// Provided by XR_BD_spatial_sensing
XrResult xrGetSpatialEntityUuidBD(
    XrSenseDataSnapshotBD                       snapshot,
    XrSpatialEntityIdBD                         entityId,
    XrUuidEXT*                                  uuid);

Parameters

Parameter Descriptions

Applications can get the UUID for a given spatial entity by calling xrGetSpatialEntityUuidBD.

Description

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_SPATIAL_ENTITY_ID_INVALID_BD

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_BD_spatial_sensing, XrSenseDataSnapshotBD, XrSpatialEntityIdBD, XrUuidEXT

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.