org.lwjgl.openxr.METALocalDimming 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_META_local_dimming extension.
 * 
 * Local dimming allows to adjust backlight intensity of dark areas on the screen in order to increase content dynamic range. Local dimming feature is not intended for optical see-through HMDs.
 * 
 * An application can request the local dimming mode on a frame basis by chaining an {@link XrLocalDimmingFrameEndInfoMETA} structure to the {@link XrFrameEndInfo}.
 * 
 * 
 * Using XrFrameEndInfoLocalDimmingFB is considered as a hint and will not trigger {@link XR10#xrEndFrame EndFrame} errors whether or not the requested dimming mode is fulfilled by the runtime.
 * The runtime will have full control of the local dimming mode and may disregard app requests. For example, the runtime may allow only one primary client to control the local dimming mode.
 * 
 */
public final class METALocalDimming {

    /** The extension specification version. */
    public static final int XR_META_local_dimming_SPEC_VERSION = 1;

    /** The extension name. */
    public static final String XR_META_LOCAL_DIMMING_EXTENSION_NAME = "XR_META_local_dimming";

    /** Extends {@code XrStructureType}. */
    public static final int XR_TYPE_LOCAL_DIMMING_FRAME_END_INFO_META = 1000216000;

    /**
     * XrLocalDimmingModeMETA - Local dimming modes
     * 
     * Enumerant Descriptions
     * 
     * 
     * {@link #XR_LOCAL_DIMMING_MODE_OFF_META LOCAL_DIMMING_MODE_OFF_META} — Local dimming is turned off by default for the current submitted frame. This is the same as not chaining {@code XrLocalDimmingModeMETA}.
     * {@link #XR_LOCAL_DIMMING_MODE_ON_META LOCAL_DIMMING_MODE_ON_META} — Local dimming is turned on for the current submitted frame.
     * 
     * 
     * See Also
     * 
     * {@link XrLocalDimmingFrameEndInfoMETA}
     */
    public static final int
        XR_LOCAL_DIMMING_MODE_OFF_META = 0,
        XR_LOCAL_DIMMING_MODE_ON_META  = 1;

    private METALocalDimming() {}

}