org.lwjgl.opengl.WGLARBMakeCurrentRead Maven / Gradle / Ivy
Show all versions of org.lwjgl.opengl Show documentation
/*
* 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 WGL_ARB_make_current_read extension.
*
* The association of a separate "read" and "draw" DC with the current context allows for preprocessing of image data in an "off screen" DC which is then
* read into a visible DC for final display.
*
* Requires {@link WGLARBExtensionsString WGL_ARB_extensions_string}.
*/
public class WGLARBMakeCurrentRead {
/** New errors returned by {@link org.lwjgl.system.windows.WinBase#GetLastError}. */
public static final int
ERROR_INVALID_PIXEL_TYPE_ARB = 0x2043,
ERROR_INCOMPATIBLE_DEVICE_CONTEXTS_ARB = 0x2054;
protected WGLARBMakeCurrentRead() {
throw new UnsupportedOperationException();
}
static boolean isAvailable(WGLCapabilities caps) {
return checkFunctions(
caps.wglMakeContextCurrentARB, caps.wglGetCurrentReadDCARB
);
}
// --- [ wglMakeContextCurrentARB ] ---
/**
* Associates the context {@code hglrc} with the device {@code drawDC} for draws and the device {@code readDC} for reads. All subsequent OpenGL calls made
* by the calling thread are drawn on the device identified by {@code drawDC} and read on the device identified by {@code readDC}.
*
* The {@code drawDC} and {@code readDC} parameters must refer to drawing surfaces supported by OpenGL. These parameters need not be the same {@code hdc}
* that was passed to {@link WGL#wglCreateContext CreateContext} when {@code hglrc} was created. {@code drawDC} must have the same pixel format and be created on the same
* physical device as the {@code hdc} that was passed into wglCreateContext. {@code readDC} must be created on the same device as the {@code hdc} that was
* passed to wglCreateContext and it must support the same pixel type as the pixel format of the {@code hdc} that was passed to wglCreateContext.
*
* If {@code wglMakeContextCurrentARB} is used to associate a different device for reads than for draws, the "read" device will be used for the following
* OpenGL operations:
*
*
* - Any pixel data that are sourced based on the value of {@link GL11#GL_READ_BUFFER READ_BUFFER}. Note, that accumulation operations use the value of {@code READ_BUFFER}, but
* are not allowed when a different device context is used for reads. In this case, the accumulation operation will generate {@link GL11#GL_INVALID_OPERATION INVALID_OPERATION}.
* - Any depth values that are retrieved by {@link GL11#glReadPixels ReadPixels}, {@link GL11#glCopyPixels CopyPixels}, or any OpenGL extension that sources depth images from the frame buffer in the
* manner of {@code ReadPixels} and {@code CopyPixels}.
* - Any stencil values that are retrieved by {@code ReadPixels}, {@code CopyPixels}, or any OpenGL extension that sources stencil images from the
* framebuffer in the manner of {@code ReadPixels} and {@code CopyPixels}.
*
*
* These frame buffer values are taken from the surface associated with the device context specified by {@code readDC}.
*
* @param drawDC the "draw" device context
* @param readDC the "read" device context
* @param hglrc the OpenGL context
*/
public static boolean wglMakeContextCurrentARB(long drawDC, long readDC, long hglrc) {
long __functionAddress = GL.getCapabilitiesWGL().wglMakeContextCurrentARB;
if (CHECKS) {
check(__functionAddress);
check(drawDC);
check(readDC);
check(hglrc);
}
return callPPPI(__functionAddress, drawDC, readDC, hglrc) != 0;
}
// --- [ wglGetCurrentReadDCARB ] ---
/** Returns the "read" device context for the current OpenGL context. */
public static long wglGetCurrentReadDCARB() {
long __functionAddress = GL.getCapabilitiesWGL().wglGetCurrentReadDCARB;
if (CHECKS) {
check(__functionAddress);
}
return callP(__functionAddress);
}
}