C Specification

The XrTrackableImageDatabaseEntryANDROID structure is defined as:

// Provided by XR_ANDROID_trackables_image
typedef struct XrTrackableImageDatabaseEntryANDROID {
    XrStructureType                        type;
    const void*                            next;
    XrTrackableImageTrackingModeANDROID    trackingMode;
    float                                  physicalWidth;
    uint32_t                               imageWidth;
    uint32_t                               imageHeight;
    XrTrackableImageFormatANDROID          format;
    uint32_t                               bufferSize;
    const uint8_t*                         buffer;
} XrTrackableImageDatabaseEntryANDROID;

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.

  • trackingMode is an XrTrackableImageTrackingModeANDROID indicating the desired mode for tracking.

  • physicalWidth indicates the width of the image in meters. If zero, the image size will be estimated online.

  • imageWidth indicates the width of the image in pixels.

  • imageHeight indicates the height of the image in pixels.

  • format is an XrTrackableImageFormatANDROID indicating the format of the image data in buffer.

  • bufferSize indicates the byte length of buffer.

  • buffer is the uint8_t buffer containing the reference image pixel data. The contents of buffer must be valid for the duration of the database creation async operation, which is started by xrCreateTrackableImageDatabaseAsyncANDROID and completed by xrCreateTrackableImageDatabaseCompleteANDROID.

Description

The application may set physicalWidth to 0 to request online size estimation if XrSystemImageTrackingPropertiesANDROID::supportsPhysicalSizeEstimation is XR_TRUE.

The runtime may return XR_ERROR_VALIDATION_FAILURE from xrCreateTrackableImageDatabaseAsyncANDROID if bufferSize does not match the expected size based on the entry’s imageWidth, imageHeight and format.

Valid Usage (Implicit)

See Also

XR_ANDROID_trackables_image, XrStructureType, XrTrackableImageDatabaseCreateInfoANDROID, XrTrackableImageFormatANDROID, XrTrackableImageTrackingModeANDROID, xrCreateTrackableImageDatabaseAsyncANDROID

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.