XrCompositionLayerPassthroughHTC(3)

C Specification

The XrCompositionLayerPassthroughHTC structure is defined as:

// Provided by XR_HTC_passthrough
typedef struct XrCompositionLayerPassthroughHTC {
    XrStructureType            type;
    const void*                next;
    XrCompositionLayerFlags    layerFlags;
    XrSpace                    space;
    XrPassthroughHTC           passthrough;
    XrPassthroughColorHTC      color;
} XrCompositionLayerPassthroughHTC;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain, such as XrPassthroughMeshTransformInfoHTC.
layerFlags is a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.
space is the XrSpace that specifies the layer’s space - must be XR_NULL_HANDLE.
passthrough is the XrPassthroughHTC previously created by xrCreatePassthroughHTC.
color is the XrPassthroughColorHTC describing the color information with the alpha value of the passthrough layer.

Description

The application can create an XrCompositionLayerPassthroughHTC structure with the created passthrough and the corresponding information. A pointer to XrCompositionLayerPassthroughHTC may be submitted in xrEndFrame as a pointer to the base structure XrCompositionLayerBaseHeader, in the desired layer order, to request the runtime to composite a passthrough layer into the final frame output.

If the passthrough form specified to xrCreatePassthroughHTC is XR_PASSTHROUGH_FORM_PROJECTED_HTC, XrPassthroughMeshTransformInfoHTC must appear in the next chain. If they are absent, the runtime must return error XR_ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

The XR_HTC_passthrough extension must be enabled prior to using XrCompositionLayerPassthroughHTC
type must be XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC
next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrPassthroughMeshTransformInfoHTC
layerFlags must be a valid combination of XrCompositionLayerFlagBits values
layerFlags must not be 0
space must be a valid XrSpace handle
passthrough must be a valid XrPassthroughHTC handle
color must be a valid XrPassthroughColorHTC structure
Both of passthrough and space must have been created, allocated, or retrieved from the same XrSession

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

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

XrCompositionLayerPassthroughHTC(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright