C Specification

The XrEnvironmentDepthImageTimestampMETA structure is defined as:

// Provided by XR_META_environment_depth
typedef struct XrEnvironmentDepthImageTimestampMETA {
    XrStructureType    type;
    const void*        next;
    XrTime             captureTime;
} XrEnvironmentDepthImageTimestampMETA;

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.

  • captureTime is an XrTime specifying when the depth image was captured.

Description

The XrEnvironmentDepthImageTimestampMETA structure provides timestamp information for environment depth data. This structure can be chained to XrEnvironmentDepthImageMETA to provide temporal context for the depth information.

The captureTime field indicates the capture time of the images used to reconstruct the environment depth map.

Applications can use this timestamp information for latency measurements and synchronization with other time-based data such as passthrough camera.

If present in the structure chain, this structure must be populated by the runtime if and only if the runtime reports version 2 or greater of this extension. This is an "unknown structure" to runtimes reporting version 1 of this extension, and is therefore ignored/unmodified according to https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#fundamentals-valid-usage-for-structure-pointer-chains.

Applications should initialize captureTime to 0 before chaining this structure and calling xrAcquireEnvironmentDepthImageMETA. After the call, a non-zero value in captureTime indicates that the runtime has populated the timestamp field.

Valid Usage (Implicit)

See Also

XR_META_environment_depth, XrStructureType, XrTime

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.