C Specification

The xrEnumerateSpatialAnchorAttachableComponentsANDROID function is defined as:

// Provided by XR_ANDROID_spatial_entity_bound_anchor
XrResult xrEnumerateSpatialAnchorAttachableComponentsANDROID(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    uint32_t                                    attachableComponentCapacityInput,
    uint32_t*                                   attachableComponentCountOutput,
    XrSpatialComponentTypeEXT*                  attachableComponents);

Parameters

Parameter Descriptions

  • instance is a handle to an XrInstance.

  • systemId is the XrSystemId whose spatial persistence stores will be enumerated.

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

  • attachableComponentCountOutput is the number of attachable components, or the required capacity in the case that attachableComponentCapacityInput is insufficient.

  • attachableComponents is an array of XrSpatialComponentTypeEXT. It can be NULL if attachableComponentCapacityInput is 0.

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

Description

Runtimes must always return identical buffer contents from this enumeration for the given systemId for the lifetime of the instance.

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

  • XR_SUCCESS

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SIZE_INSUFFICIENT

  • XR_ERROR_SYSTEM_INVALID

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_ANDROID_spatial_entity_bound_anchor, XrInstance, XrSpatialComponentTypeEXT, XrSystemId, xrCreateSpatialAnchorEXT

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-2026 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.