xrEnumerateSpatialCapabilityFeaturesEXT(3)

C Specification

The xrEnumerateSpatialCapabilityFeaturesEXT function is defines as:

// Provided by XR_EXT_spatial_entity
XrResult xrEnumerateSpatialCapabilityFeaturesEXT(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    XrSpatialCapabilityEXT                      capability,
    uint32_t                                    capabilityFeatureCapacityInput,
    uint32_t*                                   capabilityFeatureCountOutput,
    XrSpatialCapabilityFeatureEXT*              capabilityFeatures);

Parameters

Parameter Descriptions

instance is a handle to an XrInstance.
systemId is the XrSystemId whose spatial capability features will be enumerated.
capability is the XrSpatialCapabilityEXT for which the features will be enumerated.
capabilityFeatureCapacityInput is the capacity of the array, or 0 to indicate a request to retrieve the required capacity.
capabilityFeatureCountOutput is the number of features, or the required capacity in the case that capabilityFeatureCapacityInput is insufficient.
capabilityFeatures is an array of XrSpatialCapabilityFeatureEXT. It can be NULL if capabilityFeatureCapacityInput 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 capabilityFeatures size.

The application discovers the features supported by a given system for a XrSpatialCapabilityEXT by using xrEnumerateSpatialCapabilityFeaturesEXT.

Description

For capabilities that have features exposed, the application selects the feature or features to enable and provides the corresponding configuration structure in the next chain of the capability configuration structures in XrSpatialContextCreateInfoEXT::capabilityConfigs.

If capability is not a capability enumerated by xrEnumerateSpatialCapabilitiesEXT, the runtime must return XR_ERROR_SPATIAL_CAPABILITY_UNSUPPORTED_EXT.

The runtime must not enumerate the spatial capability features whose extension is not enabled for instance.

Valid Usage (Implicit)

The XR_EXT_spatial_entity extension must be enabled prior to calling xrEnumerateSpatialCapabilityFeaturesEXT
instance must be a valid XrInstance handle
capability must be a valid XrSpatialCapabilityEXT value
capabilityFeatureCountOutput must be a pointer to a uint32_t value
If capabilityFeatureCapacityInput is not 0, capabilityFeatures must be a pointer to an array of capabilityFeatureCapacityInput XrSpatialCapabilityFeatureEXT values

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

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

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

xrEnumerateSpatialCapabilityFeaturesEXT(3) Manual Page

Name

C Specification

Parameters

Description

See Also

Document Notes

Copyright