C Specification

The XrSystemPassthroughLayerPropertiesANDROID structure is defined as:

// Provided by XR_ANDROID_composition_layer_passthrough_mesh
typedef struct XrSystemPassthroughLayerPropertiesANDROID {
    XrStructureType    type;
    void*              next;
    XrBool32           supportsPassthroughLayer;
    uint32_t           maxMeshIndexCount;
    uint32_t           maxMeshVertexCount;
} XrSystemPassthroughLayerPropertiesANDROID;

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.

  • supportsPassthroughLayer is an XrBool32, indicating if the current system supports composition layer passthrough mesh.

  • maxMeshIndexCount is a uint32_t returns the maximum count of indices that will be accepted for a passthrough mesh.

  • maxMeshVertexCount is a uint32_t returns the maximum count of vertices that will be accepted for a passthrough mesh.

Description

An application inspects whether the system is capable of composition layer passthrough mesh by chaining an XrSystemPassthroughLayerPropertiesANDROID structure to the XrSystemProperties when calling xrGetSystemProperties.

If a runtime returns XR_FALSE for supportsPassthroughLayer, the system does not support composition layer passthrough mesh, and therefore must return XR_ERROR_FEATURE_UNSUPPORTED from xrCreatePassthroughLayerANDROID. The application should avoid using composition layer passthrough mesh when supportsPassthroughLayer is XR_FALSE.

If a runtime returns XR_TRUE for supportsPassthroughLayer, the system supports composition layer passthrough mesh. In this case, the runtime must return a non-zero number for maxMeshIndexCount and maxMeshVertexCount. An application must not exceed maxMeshIndexCount and maxMeshVertexCount as the maximum values to set passthrough meshes when calling xrCreatePassthroughLayerANDROID and xrSetPassthroughLayerMeshANDROID, otherwise the runtime must return XR_ERROR_MESH_DATA_LIMIT_EXCEEDED_ANDROID to indicate the mesh data exceeds the supported limit.

Valid Usage (Implicit)

See Also

XR_ANDROID_composition_layer_passthrough_mesh, XrBool32, XrStructureType, XrSystemProperties, xrGetSystemProperties

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.