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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-opengl Show documentation
The most widely adopted 2D and 3D graphics API in the industry, bringing thousands of applications to a wide variety of computer platforms.
There is a newer version: 3.3.5
Show newest version
/*
 * 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 org.lwjgl.system.*;

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

/**
 * Native bindings to the WGL_ARB_create_context extension.
 * 
 * With the advent of new versions of OpenGL which deprecate features and/or break backward compatibility with older versions, there is a need and desire
 * to indicate at context creation which interface will be used. This extension add a new context creation routine with attributes specifying the GL
 * version and context properties requested for the context.
 * 
 * Requires {@link WGLARBExtensionsString WGL_ARB_extensions_string}.
 */
public class WGLARBCreateContext {

    /** Accepted as an attribute name in {@code attribList}. */
    public static final int
        WGL_CONTEXT_MAJOR_VERSION_ARB = 0x2091,
        WGL_CONTEXT_MINOR_VERSION_ARB = 0x2092,
        WGL_CONTEXT_LAYER_PLANE_ARB   = 0x2093,
        WGL_CONTEXT_FLAGS_ARB         = 0x2094;

    /** Accepted as bits in the attribute value for {@link #WGL_CONTEXT_FLAGS_ARB CONTEXT_FLAGS_ARB} in {@code attribList}. */
    public static final int
        WGL_CONTEXT_DEBUG_BIT_ARB              = 0x1,
        WGL_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB = 0x2;

    /** New errors returned by {@link org.lwjgl.system.windows.WinBase#GetLastError}. */
    public static final int ERROR_INVALID_VERSION_ARB = 0x2095;

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

    static boolean isAvailable(WGLCapabilities caps) {
        return checkFunctions(
            caps.wglCreateContextAttribsARB
        );
    }

    // --- [ wglCreateContextAttribsARB ] ---

    /** Unsafe version of: {@link #wglCreateContextAttribsARB CreateContextAttribsARB} */
    public static long nwglCreateContextAttribsARB(long hdc, long shareContext, long attribList) {
        long __functionAddress = GL.getCapabilitiesWGL().wglCreateContextAttribsARB;
        if (CHECKS) {
            check(__functionAddress);
            check(hdc);
        }
        return callPPPP(__functionAddress, hdc, shareContext, attribList);
    }

    /**
     * Creates an OpenGL context.
     * 
     * If {@code shareContext} is not {@code NULL}, then all shareable data (excluding OpenGL texture objects named 0) will be shared by {@code shareContext}, all
     * other contexts {@code shareContext} already shares with, and the newly created context. An arbitrary number of contexts can share data in this fashion.
     *
     * @param hdc          
     * @param shareContext 
     * @param attribList   a list of attributes for the context. The list consists of a sequence of <name, value> pairs terminated by the value 0. If an attribute is not
     *                     specified in {@code attribList}, then the default value is used instead. If an attribute is specified more than once, then the last value specified
     *                     is used.
     */
    @NativeType("HGLRC")
    public static long wglCreateContextAttribsARB(@NativeType("HDC") long hdc, @NativeType("HGLRC") long shareContext, @NativeType("const int *") IntBuffer attribList) {
        if (CHECKS) {
            checkNTSafe(attribList);
        }
        return nwglCreateContextAttribsARB(hdc, shareContext, memAddressSafe(attribList));
    }

    /** Array version of: {@link #wglCreateContextAttribsARB CreateContextAttribsARB} */
    @NativeType("HGLRC")
    public static long wglCreateContextAttribsARB(@NativeType("HDC") long hdc, @NativeType("HGLRC") long shareContext, @NativeType("const int *") int[] attribList) {
        long __functionAddress = GL.getCapabilitiesWGL().wglCreateContextAttribsARB;
        if (CHECKS) {
            check(__functionAddress);
            check(hdc);
            checkNTSafe(attribList);
        }
        return callPPPP(__functionAddress, hdc, shareContext, attribList);
    }

}