C Specification

The xrGetSpatialEntityComponentDataBD function is defined as:

// Provided by XR_BD_spatial_sensing
XrResult xrGetSpatialEntityComponentDataBD(
    XrSenseDataSnapshotBD                       snapshot,
    const XrSpatialEntityComponentGetInfoBD*    getInfo,
    XrSpatialEntityComponentDataBaseHeaderBD*   componentData);

Parameters

Parameter Descriptions

Description

The application can use xrGetSpatialEntityComponentDataBD to get the component data of a spatial entity.

The runtime must return XR_ERROR_VALIDATION_FAILURE if the component type is not present on a given entity.

The XrSpatialEntityComponentGetInfoBD::componentType must match the type of the output XrSpatialEntityComponentData* structure passed as componentData when querying certain component data with xrGetSpatialEntityComponentDataBD. Otherwise, the runtime must return XR_ERROR_VALIDATION_FAILURE from xrGetSpatialEntityComponentDataBD.

If a given component type requires passing additional input through the XrSpatialEntityComponentGetInfoBD::next chain, but that input is not present, the runtime must return XR_ERROR_VALIDATION_FAILURE.

Some component data types (types passed to componentData) use the structure form of the two call idiom to populate buffers of variable sizes.

The runtime must not change the component data in the snapshot until the snapshot is destroyed.

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_SIZE_INSUFFICIENT

  • 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, XrSpatialEntityComponentDataBaseHeaderBD, XrSpatialEntityComponentGetInfoBD

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.