C Specification

The XrCompositionLayerPassthroughFB structure is defined as:

// Provided by XR_FB_passthrough
typedef struct XrCompositionLayerPassthroughFB {
    XrStructureType            type;
    const void*                next;
    XrCompositionLayerFlags    flags;
    XrSpace                    space;
    XrPassthroughLayerFB       layerHandle;
} XrCompositionLayerPassthroughFB;

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.

  • flags is a bitmask of XrCompositionLayerFlagBits that specify additional behavior.

  • space is the XrSpace that specifies the layer’s space - must be XR_NULL_HANDLE.

  • layerHandle is the XrPassthroughLayerFB that defines this layer’s behavior.

Description

It is a composition layer type that may be submitted in xrEndFrame where an XrCompositionLayerBaseHeader is specified, as a stand-in for the actual passthrough contents.

Errata: the third field of this structure is named flags rather than layerFlags as expected and as documented for for the parent type XrCompositionLayerBaseHeader.

Valid Usage (Implicit)

See Also

XR_FB_passthrough, XrCompositionLayerBaseHeader, XrCompositionLayerFlags, XrPassthroughLayerFB, XrSpace, 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-2025 The Khronos Group Inc.

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