C Specification

The XrFrameEndInfo structure is defined as:

typedef struct XrFrameEndInfo {
    XrStructureType                               type;
    const void* XR_MAY_ALIAS                      next;
    XrTime                                        displayTime;
    XrEnvironmentBlendMode                        environmentBlendMode;
    uint32_t                                      layerCount;
    const XrCompositionLayerBaseHeader* const*    layers;
} XrFrameEndInfo;

Members

Member Descriptions
  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to an extension-specific structure.

  • displayTime is the XrTime at which this frame should be displayed.

  • environmentBlendMode is the XrEnvironmentBlendMode value representing the desired environment blend mode for this frame.

  • layerCount is the number of composition layers in this frame. The maximum supported layer count is identified by XrSystemGraphicsProperties::maxLayerCount. If layerCount is greater than the maximum supported layer count then XR_ERROR_LAYER_LIMIT_EXCEEDED is returned. The runtime must support at least XR_MIN_COMPOSITION_LAYERS_SUPPORTED layers.

  • layers is a pointer to an array of XrCompositionLayerBaseHeader pointers.

Description

Valid Usage (Implicit)
  • type must be XR_TYPE_FRAME_END_INFO

  • next must be NULL

  • environmentBlendMode must be a valid XrEnvironmentBlendMode value

  • If layerCount is not 0, layerCount must be a valid uint32_t value

  • If layerCount is not 0, layers must be a pointer to an array of layerCount valid XrCompositionLayerBaseHeader structures

See Also

Document Notes

For more information, see the OpenXR Specification at URL

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.