C Specification

The XrSystemImageTrackingPropertiesANDROID structure is defined as:

// Provided by XR_ANDROID_trackables_image
typedef struct XrSystemImageTrackingPropertiesANDROID {
    XrStructureType    type;
    void*              next;
    XrBool32           supportsImageTracking;
    XrBool32           supportsPhysicalSizeEstimation;
    uint32_t           maxTrackedImageCount;
    uint32_t           maxLoadedImageCount;
} XrSystemImageTrackingPropertiesANDROID;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

  • supportsImageTracking is an XrBool32 indicating if current system provides image tracking capability.

  • supportsPhysicalSizeEstimation is an XrBool32 indicating if current system provides image size estimation.

  • maxTrackedImageCount is the total maximum number of images that can be tracked at the same time.

  • maxLoadedImageCount is the total maximum number of reference images that can be loaded across all databases.

Description

An application can inspect whether the system is capable of image tracking by extending the XrSystemProperties with XrSystemImageTrackingPropertiesANDROID structure when calling xrGetSystemProperties. The runtime must return XR_ERROR_FEATURE_UNSUPPORTED for image tracker creation if and only if supportsImageTracking is XR_FALSE.

If a runtime supports image tracking, it must support maxTrackedImageCount tracked images at any given time.

If a runtime supports image tracking, it must support maxLoadedImageCount loaded images at any given time.

If a runtime supports image size estimation, the application can set XrTrackableImageDatabaseEntryANDROID::physicalWidth 0 to indicate the usage of size estimation. Otherwise, the application must set XrTrackableImageDatabaseEntryANDROID::physicalWidth to a positive value or XR_ERROR_VALIDATION_FAILURE will be returned.

Valid Usage (Implicit)

See Also

XR_ANDROID_trackables_image, XrBool32, XrStructureType

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-2026 The Khronos Group Inc.

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