C Specification

The xrEnumerateSpatialCapabilityComponentTypesEXT function is defined as:

// Provided by XR_EXT_spatial_entity
XrResult xrEnumerateSpatialCapabilityComponentTypesEXT(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    XrSpatialCapabilityEXT                      capability,
    XrSpatialCapabilityComponentTypesEXT*       capabilityComponents);

Parameters

Parameter Descriptions

Description

This function enumerates the component types that the given capability provides on its entities in the system as configured.

The application can use the component types enumerated in XrSpatialCapabilityComponentTypesEXT::componentTypes to understand the full set of components that the systemId supports for capability and can use this list to determine what a valid configuration for capability is when creating an XrSpatialContextEXT for it.

The runtime must return XR_ERROR_SPATIAL_CAPABILITY_UNSUPPORTED_EXT if capability is not enumerated by xrEnumerateSpatialCapabilitiesEXT.

The runtime must not enumerate the spatial component types whose extension is not enabled for instance.

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

  • XR_ERROR_SPATIAL_CAPABILITY_UNSUPPORTED_EXT

See Also

XR_EXT_spatial_entity, XrInstance, XrSpatialCapabilityComponentTypesEXT, XrSpatialCapabilityEXT, XrSpatialComponentTypeEXT, XrSystemId, xrEnumerateSpatialCapabilitiesEXT

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.