xrEnumerateSupportedPersistenceAnchorTypesANDROID(3)

C Specification

The xrEnumerateSupportedPersistenceAnchorTypesANDROID function is defined as:

// Provided by XR_ANDROID_device_anchor_persistence
XrResult xrEnumerateSupportedPersistenceAnchorTypesANDROID(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    uint32_t                                    trackableTypeCapacityInput,
    uint32_t*                                   trackableTypeCountOutput,
    XrTrackableTypeANDROID*                     trackableTypes);

Parameters

Parameter Descriptions

instance is the XrInstance that creates the XrDeviceAnchorPersistenceANDROID.
systemId is the XrSystemId that is enumerated for supported types.
trackableTypeCapacityInput is the capacity of the trackableTypes, or 0 to retrieve the required capacity.
trackableTypeCountOutput is a pointer to the count of trackableTypes written, or a pointer to the required capacity in the case that trackableTypeCapacityInput is insufficient.
trackableTypes is a pointer to an array of XrTrackableTypeANDROID, but can be NULL if trackableTypeCapacityInput 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 trackableTypes size.

Description

To check for support of anchor persistence on other XrTrackableTypeANDROID trackables the application calls xrEnumerateSupportedPersistenceAnchorTypesANDROID.

If and only if a runtime does not return a given XrTrackableTypeANDROID in the trackableTypes array, the runtime must return XR_ERROR_FEATURE_UNSUPPORTED from device anchor persistence functions that operate on an anchor of that type.

Valid Usage (Implicit)

The XR_ANDROID_device_anchor_persistence extension must be enabled prior to calling xrEnumerateSupportedPersistenceAnchorTypesANDROID
instance must be a valid XrInstance handle
trackableTypeCountOutput must be a pointer to a uint32_t value
If trackableTypeCapacityInput is not 0, trackableTypes must be a pointer to an array of trackableTypeCapacityInput XrTrackableTypeANDROID 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.

xrEnumerateSupportedPersistenceAnchorTypesANDROID(3) Manual Page

Name

C Specification

Parameters

Description

See Also

Document Notes

Copyright