C Specification

The xrEnumerateSpatialPersistenceScopesEXT function is defined as:

// Provided by XR_EXT_spatial_persistence
XrResult xrEnumerateSpatialPersistenceScopesEXT(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    uint32_t                                    persistenceScopeCapacityInput,
    uint32_t*                                   persistenceScopeCountOutput,
    XrSpatialPersistenceScopeEXT*               persistenceScopes);

Parameters

Parameter Descriptions

  • instance is a handle to an XrInstance.

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

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

  • persistenceScopeCountOutput is the number of persistence scopes, or the required capacity in the case that persistenceScopeCapacityInput is insufficient.

  • persistenceScopes is an array of XrSpatialPersistenceScopeEXT. It can be NULL if persistenceScopeCapacityInput is 0.

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

Description

The application can enumerate the list of spatial persistence scopes supported by a given XrSystemId using xrEnumerateSpatialPersistenceScopesEXT.

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_EXT_spatial_persistence, XrInstance, XrSpatialPersistenceContextCreateInfoEXT, XrSpatialPersistenceScopeEXT, XrSystemId

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.