xrEnumerateSpatialCapabilitiesEXT(3)

C Specification

The xrEnumerateSpatialCapabilitiesEXT function is defined as:

// Provided by XR_EXT_spatial_entity
XrResult xrEnumerateSpatialCapabilitiesEXT(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    uint32_t                                    capabilityCapacityInput,
    uint32_t*                                   capabilityCountOutput,
    XrSpatialCapabilityEXT*                     capabilities);

Parameters

Parameter Descriptions

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

Description

The application can enumerate the list of spatial capabilities supported by a given XrSystemId using xrEnumerateSpatialCapabilitiesEXT.

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

Valid Usage (Implicit)

The XR_EXT_spatial_entity extension must be enabled prior to calling xrEnumerateSpatialCapabilitiesEXT
instance must be a valid XrInstance handle
capabilityCountOutput must be a pointer to a uint32_t value
If capabilityCapacityInput is not 0, capabilities must be a pointer to an array of capabilityCapacityInput XrSpatialCapabilityEXT 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

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.

xrEnumerateSpatialCapabilitiesEXT(3) Manual Page

Name

C Specification

Parameters

Description

See Also

Document Notes

Copyright