C Specification

The xrEnumerateSpatialEntityComponentTypesBD function is defined as:

// Provided by XR_BD_spatial_sensing
XrResult xrEnumerateSpatialEntityComponentTypesBD(
    XrSenseDataSnapshotBD                       snapshot,
    XrSpatialEntityIdBD                         entityId,
    uint32_t                                    componentTypeCapacityInput,
    uint32_t*                                   componentTypeCountOutput,
    XrSpatialEntityComponentTypeBD*             componentTypes);

Parameters

Parameter Descriptions

  • snapshot is the XrSenseDataSnapshotBD handle.

  • entityId is the XrSpatialEntityIdBD whose spatial entity component types will be enumerated.

  • componentTypeCapacityInput is the capacity of the componentTypes array, or 0 to indicate a request to retrieve the required capacity.

  • componentTypeCountOutput is the number of component types, or the required capacity in the case that componentTypeCapacityInput is insufficient.

  • componentTypes is an array of XrSpatialEntityComponentTypeBD. It can be NULL if componentTypeCapacityInput is 0.

  • See Buffer Size Parameters chapter for a detailed description of retrieving the required componentTypes size.

The application inspects the component types for a given XrSpatialEntityIdBD using xrEnumerateSpatialEntityComponentTypesBD. The application may skip enumerating component types and proceed directly to attempting to access component data.

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_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, XrSpatialEntityComponentTypeBD, XrSpatialEntityIdBD

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.