org.lwjgl.opengl.GLXSGIMakeCurrentRead 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 static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;

/**
 * Native bindings to the GLX_SGI_make_current_read extension.
 * 
 * The association of the current context with a drawable is extended to allow separate write and read drawables.  This paves the way for allowing
 * preprocessing of image data in an "off screen" window which is then read into the visible window for final display.  Similarly it sets the frame-work
 * for direct transfer of video to the GL, by treating the video as a special kind of read drawable (a.k.a, readable).
 */
public class GLXSGIMakeCurrentRead {

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

    static boolean isAvailable(GLXCapabilities caps) {
        return checkFunctions(
            caps.glXMakeCurrentReadSGI, caps.glXGetCurrentReadDrawableSGI
        );
    }

    // --- [ glXMakeCurrentReadSGI ] ---

    /**
     * Associates two {@code GLXDrawables} with the current rendering context.
     *
     * @param display the connection to the X server
     * @param draw    the draw drawable
     * @param read    the read drawable
     * @param ctx     the current context
     */
    public static boolean glXMakeCurrentReadSGI(long display, long draw, long read, long ctx) {
        long __functionAddress = GL.getCapabilitiesGLXClient().glXMakeCurrentReadSGI;
        if (CHECKS) {
            check(__functionAddress);
            check(display);
        }
        return callPPPPI(__functionAddress, display, draw, read, ctx) != 0;
    }

    // --- [ glXGetCurrentReadDrawableSGI ] ---

    /** Returns the name of the {@code GLXDrawable} currently being used as a pixel query source. */
    public static long glXGetCurrentReadDrawableSGI() {
        long __functionAddress = GL.getCapabilitiesGLXClient().glXGetCurrentReadDrawableSGI;
        if (CHECKS) {
            check(__functionAddress);
        }
        return callP(__functionAddress);
    }

}