XrCompositionLayerCylinderKHR(3)

C Specification

The XrCompositionLayerCylinderKHR structure is defined as:

typedef struct XrCompositionLayerCylinderKHR {
    XrStructureType             type;
    const void* XR_MAY_ALIAS    next;
    XrCompositionLayerFlags     layerFlags;
    XrSpace                     space;
    XrEyeVisibility             eyeVisibility;
    XrSwapchainSubImage         subImage;
    XrPosef                     pose;
    float                       radius;
    float                       centralAngle;
    float                       aspectRatio;
} XrCompositionLayerCylinderKHR;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to an extension-specific structure.
layerFlags specifies options for the layer.
space is the XrSpace in which the pose of the cylinder layer is evaluated over time.
eye is the eye represented by this layer.
subImage identifies the image XrSwapchainSubImage to use.
pose is an XrPosef defining the position and orientation of the center point of the view of the cylinder within the reference frame of the space.
radius is the radius of the cylinder.
centralAngle is the angle of the visible section of the cylinder, based at 0 radians, in the range of [0, 2*Pi). It grows symmetrically around the 0 radian angle.
aspectRatio is the ratio of the visible cylinder section width / height. The height of the cylinder is given by: (cylinder radius * cylinder angle) / aspectRatio.

Description

XrCompositionLayerCylinderKHR contains the information needed to render a texture onto a cylinder when calling xrEndFrame. XrCompositionLayerCylinderKHR is an alias type for the base struct XrCompositionLayerBaseHeader used in XrFrameEndInfo.

Valid Usage (Implicit)

The [XR_KHR_composition_layer_cylinder] extension must be enabled prior to using XrCompositionLayerCylinderKHR
type must be XR_TYPE_COMPOSITION_LAYER_CYLINDER_KHR
next must be NULL
layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values
space must be a valid XrSpace handle
eyeVisibility must be a valid XrEyeVisibility value
subImage must be a valid XrSwapchainSubImage structure
radius must be a valid float value
centralAngle must be a valid float value
aspectRatio must be a valid float value

Document Notes

For more information, see the OpenXR Specification at URL

https://www.khronos.org/registry/openxr/specs/1.0-extensions/html/xrspec.html#XrCompositionLayerCylinderKHR

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

XrCompositionLayerCylinderKHR(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright