org.lwjgl.openxr.KHRCompositionLayerCylinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lwjgl-openxr Show documentation

A royalty-free, open standard that provides high-performance access to Augmented Reality (AR) and Virtual Reality (VR)—collectively known as XR—platforms and devices.

There is a newer version: 3.3.6

Show newest version

/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.openxr;

/**
 * The XR_KHR_composition_layer_cylinder extension.
 * 
 * This extension adds an additional layer type where the XR runtime must map a texture stemming from a swapchain onto the inside of a cylinder section. It can be imagined much the same way a curved television display looks to a viewer. This is not a projection type of layer but rather an object-in-world type of layer, similar to {@link XrCompositionLayerQuad}. Only the interior of the cylinder surface must be visible; the exterior of the cylinder is not visible and must not be drawn by the runtime.
 * 
 * The cylinder characteristics are specified by the following parameters:
 * 
 * 
 *      XrPosef           pose;
 *      float             radius;
 *      float             centralAngle;
 *      float             aspectRatio;
 * 
 * These can be understood via the following diagram, which is a top-down view of a horizontally oriented cylinder. The aspect ratio drives how tall the cylinder will appear based on the other parameters. Typically the aspectRatio would be set to be the aspect ratio of the texture being used, so that it looks the same within the cylinder as it does in 2D.
 * 
 * 
 * r — Radius
 * a — Central angle in (0, 2π)
 * p — Origin of pose transform
 * U/V — UV coordinates
 * 
 */
public final class KHRCompositionLayerCylinder {

    /** The extension specification version. */
    public static final int XR_KHR_composition_layer_cylinder_SPEC_VERSION = 4;

    /** The extension name. */
    public static final String XR_KHR_COMPOSITION_LAYER_CYLINDER_EXTENSION_NAME = "XR_KHR_composition_layer_cylinder";

    /** Extends {@code XrStructureType}. */
    public static final int XR_TYPE_COMPOSITION_LAYER_CYLINDER_KHR = 1000017000;

    private KHRCompositionLayerCylinder() {}

}