org.lwjgl.openxr.FBCompositionLayerAlphaBlend 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_FB_composition_layer_alpha_blend extension.
 * 
 * This extension provides explicit control over source and destination blend factors, with separate controls for color and alpha. When specified, these blend controls supersede the behavior of {@link XR10#XR_COMPOSITION_LAYER_BLEND_TEXTURE_SOURCE_ALPHA_BIT COMPOSITION_LAYER_BLEND_TEXTURE_SOURCE_ALPHA_BIT}, as well as the layer blending operation which defined in the section of Composition Layer Blending.
 * 
 * When {@link XR10#XR_COMPOSITION_LAYER_UNPREMULTIPLIED_ALPHA_BIT COMPOSITION_LAYER_UNPREMULTIPLIED_ALPHA_BIT} is specified, the source color is unpremultiplied alpha.
 * 
 * Like color, destination alpha is initialized to 0 before composition begins.
 * 
 * In order to enable the functionality of this extension, the application must pass the name of the extension into {@link XR10#xrCreateInstance CreateInstance} via the {@link XrInstanceCreateInfo}{@code ::enabledExtensionNames} parameter as indicated in the extension section.
 * 
 * These blend factors are specified by attaching a {@link XrCompositionLayerAlphaBlendFB} structure to the {@code next} chain of a layer structure derived from {@link XrCompositionLayerBaseHeader}.
 * 
 * Warning
 * 
 * Please note that using this extension is mutually exclusive with accessing an environment blend mode other than {@link XR10#XR_ENVIRONMENT_BLEND_MODE_OPAQUE ENVIRONMENT_BLEND_MODE_OPAQUE}. The latter must be the only mode returned from {@link XR10#xrEnumerateEnvironmentBlendModes EnumerateEnvironmentBlendModes} if this extension is enabled. Application should not enable this extension if a different value of {@code XrEnvironmentBlendMode} is required.
 */
public final class FBCompositionLayerAlphaBlend {

    /** The extension specification version. */
    public static final int XR_FB_composition_layer_alpha_blend_SPEC_VERSION = 3;

    /** The extension name. */
    public static final String XR_FB_COMPOSITION_LAYER_ALPHA_BLEND_EXTENSION_NAME = "XR_FB_composition_layer_alpha_blend";

    /** Extends {@code XrStructureType}. */
    public static final int XR_TYPE_COMPOSITION_LAYER_ALPHA_BLEND_FB = 1000041001;

    /**
     * XrBlendFactorFB - Blend Factor Types
     * 
     * See Also
     * 
     * {@link XrCompositionLayerAlphaBlendFB}
     * 
     * Enum values:
     * 
     * 
     * {@link #XR_BLEND_FACTOR_ZERO_FB BLEND_FACTOR_ZERO_FB}
     * {@link #XR_BLEND_FACTOR_ONE_FB BLEND_FACTOR_ONE_FB}
     * {@link #XR_BLEND_FACTOR_SRC_ALPHA_FB BLEND_FACTOR_SRC_ALPHA_FB}
     * {@link #XR_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA_FB BLEND_FACTOR_ONE_MINUS_SRC_ALPHA_FB}
     * {@link #XR_BLEND_FACTOR_DST_ALPHA_FB BLEND_FACTOR_DST_ALPHA_FB}
     * {@link #XR_BLEND_FACTOR_ONE_MINUS_DST_ALPHA_FB BLEND_FACTOR_ONE_MINUS_DST_ALPHA_FB}
     * 
     */
    public static final int
        XR_BLEND_FACTOR_ZERO_FB                = 0,
        XR_BLEND_FACTOR_ONE_FB                 = 1,
        XR_BLEND_FACTOR_SRC_ALPHA_FB           = 2,
        XR_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA_FB = 3,
        XR_BLEND_FACTOR_DST_ALPHA_FB           = 4,
        XR_BLEND_FACTOR_ONE_MINUS_DST_ALPHA_FB = 5;

    private FBCompositionLayerAlphaBlend() {}

}