org.lwjgl.opengl.NVInternalformatSampleQuery Maven / Gradle / Ivy

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

import java.nio.*;

import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;
import static org.lwjgl.system.MemoryUtil.*;

/**
 * Native bindings to the NV_internalformat_sample_query extension.
 * 
 * Some OpenGL implementations support modes of multisampling which have
 * properties which are non-obvious to applications and/or which may not be
 * standards conformant. The idea of non-conformant AA modes is not new,
 * and is exposed in both GLX and EGL with config caveats and the
 * GLX_NON_CONFORMANT_CONFIG for GLX and EGL_NON_CONFORMANT_CONFIG for EGL,
 * or by querying the EGL_CONFORMANT attribute in newer versions of EGL.
 * 
 * Both of these mechanisms operate on a per-config basis, which works as
 * intended for window-based configs. However, with the advent of
 * application-created FBOs, it is now possible to do all the multisample
 * operations in an application-created FBO and never use a multisample
 * window.
 * 
 * This extension further extends the internalformat query mechanism
 * (first introduced by ARB_internalformat_query and extended in
 * ARB_internalformat_query2) and introduces a mechanism for a
 * implementation to report properties of formats that may also be
 * dependent on the number of samples.  This includes information
 * such as whether the combination of format and samples should be
 * considered conformant. This enables an implementation to report
 * caveats which might apply to both window and FBO-based rendering
 * configurations.
 * 
 * Requires {@link GL42 OpenGL 4.2} or {@link ARBInternalformatQuery ARB_internalformat_query}.
 */
public class NVInternalformatSampleQuery {

    /** Accepted by the {@code pname} parameter of GetInternalformatSampleivNV */
    public static final int
        GL_MULTISAMPLES_NV        = 0x9371,
        GL_SUPERSAMPLE_SCALE_X_NV = 0x9372,
        GL_SUPERSAMPLE_SCALE_Y_NV = 0x9373,
        GL_CONFORMANT_NV          = 0x9374;

    static { GL.initialize(); }

    protected NVInternalformatSampleQuery() {
        throw new UnsupportedOperationException();
    }

    static boolean isAvailable(GLCapabilities caps) {
        return checkFunctions(
            caps.glGetInternalformatSampleivNV
        );
    }

    // --- [ glGetInternalformatSampleivNV ] ---

    public static native void nglGetInternalformatSampleivNV(int target, int internalformat, int samples, int pname, int bufSize, long params);

    public static void glGetInternalformatSampleivNV(int target, int internalformat, int samples, int pname, IntBuffer params) {
        nglGetInternalformatSampleivNV(target, internalformat, samples, pname, params.remaining(), memAddress(params));
    }

    /** Array version of: {@link #glGetInternalformatSampleivNV GetInternalformatSampleivNV} */
    public static void glGetInternalformatSampleivNV(int target, int internalformat, int samples, int pname, int[] params) {
        long __functionAddress = GL.getICD().glGetInternalformatSampleivNV;
        if (CHECKS) {
            check(__functionAddress);
        }
        callPV(__functionAddress, target, internalformat, samples, pname, params.length, params);
    }

}