C Specification

The xrEnumerateSupportedTrackableTypesANDROID function is defined as:

// Provided by XR_ANDROID_trackables
XrResult xrEnumerateSupportedTrackableTypesANDROID(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    uint32_t                                    trackableTypeCapacityInput,
    uint32_t*                                   trackableTypeCountOutput,
    XrTrackableTypeANDROID*                     trackableTypes);

Parameters

Parameter Descriptions

  • instance is the XrInstance that enumerates the supported trackable types.

  • systemId is the XrSystemId of the system to query.

  • trackableTypeCapacityInput is the capacity of the trackableTypes, or 0 to retrieve the required capacity.

  • trackableTypeCountOutput is a pointer to the count of uint64_t trackableTypes written, or a pointer to the required capacity in the case that trackableTypeCapacityInput is insufficient.

  • trackableTypes is a pointer to an array of XrTrackableTypeANDROID, but can be NULL if trackableTypeCapacityInput is 0.

  • See the https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#fundamentals-buffer-size-parameters section for a detailed description of retrieving the required trackableTypes size.

Description

xrEnumerateSupportedTrackableTypesANDROID enumerates the trackable types supported by the runtime for xrCreateTrackableTrackerANDROID.

If and only if a trackable type X is not returned by xrEnumerateSupportedTrackableTypesANDROID, then the runtime must return XR_ERROR_FEATURE_UNSUPPORTED when calling xrCreateTrackableTrackerANDROID with X as the trackable type.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

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_SIZE_INSUFFICIENT

  • XR_ERROR_SYSTEM_INVALID

See Also

XR_ANDROID_trackables, XrInstance, XrSystemId, XrTrackableTypeANDROID

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.