org.lwjgl.opengl.WGLARBPbuffer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.lwjgl.opengl Show documentation
Show all versions of org.lwjgl.opengl Show documentation
LWJGL OSGi bundle (OpenGL bindings)
/*
* 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 WGL_ARB_pbuffer extension.
*
* This extension defines pixel buffers (pbuffer for short). Pbuffers are additional non-visible rendering buffers for an OpenGL renderer. Pbuffers are
* equivalent to a window that has the same pixel format descriptor with the following exceptions:
*
*
* - There is no rendering to a pbuffer by GDI.
* - The pixel format descriptors used for a pbuffer can only be those that are supported by the ICD. Generic formats are not valid.
* - The allocation of a pbuffer can fail if there are insufficient resources (i.e., all the pbuffer memory has been allocated).
* - The pixel buffer might be lost if a display mode change occurs. A query is provided that can be called after a display mode change to determine the
* state of the pixel buffer.
*
*
* The intent of the pbuffer semantics is to enable implementations to allocate pbuffers in non-visible frame buffer memory. These pbuffers are intended to
* be "static" resources in that a program will typically allocate them only once rather than as a part of its rendering loop. (Pbuffers should be
* deallocated when the program is no longer using them -- for example, if the program is iconified.)
*
* The frame buffer resources that are associated with a pbuffer are also static and are deallocated when the pbuffer is destroyed or possibly when a
* display mode change occurs.
*
* Requires {@link WGLARBExtensionsString WGL_ARB_extensions_string} and {@link WGLARBPixelFormat WGL_ARB_pixel_format}.
*/
public class WGLARBPbuffer {
/**
* Accepted by the {@code attribIList} parameter of {@link WGLARBPixelFormat#wglChoosePixelFormatARB ChoosePixelFormatARB} and the {@code attributes} parameter of
* {@link WGLARBPixelFormat#wglGetPixelFormatAttribivARB GetPixelFormatAttribivARB}.
*/
public static final int WGL_DRAW_TO_PBUFFER_ARB = 0x202D;
/** Accepted by the {@code attributes} parameter of {@link WGLARBPixelFormat#wglGetPixelFormatAttribivARB GetPixelFormatAttribivARB}. */
public static final int
WGL_MAX_PBUFFER_PIXELS_ARB = 0x202E,
WGL_MAX_PBUFFER_WIDTH_ARB = 0x202F,
WGL_MAX_PBUFFER_HEIGHT_ARB = 0x2030;
/** Accepted by the {@code attribList} parameter of {@link #wglCreatePbufferARB CreatePbufferARB}. */
public static final int WGL_PBUFFER_LARGEST_ARB = 0x2033;
/** Accepted by the {@code attribute} parameter of {@link #wglQueryPbufferARB QueryPbufferARB}. */
public static final int
WGL_PBUFFER_WIDTH_ARB = 0x2034,
WGL_PBUFFER_HEIGHT_ARB = 0x2035,
WGL_PBUFFER_LOST_ARB = 0x2036;
protected WGLARBPbuffer() {
throw new UnsupportedOperationException();
}
static boolean isAvailable(WGLCapabilities caps) {
return checkFunctions(
caps.wglCreatePbufferARB, caps.wglGetPbufferDCARB, caps.wglReleasePbufferDCARB, caps.wglDestroyPbufferARB, caps.wglQueryPbufferARB
);
}
// --- [ wglCreatePbufferARB ] ---
/** Unsafe version of: {@link #wglCreatePbufferARB CreatePbufferARB} */
public static long nwglCreatePbufferARB(long hdc, int pixelFormat, int width, int height, long attribList) {
long __functionAddress = GL.getCapabilitiesWGL().wglCreatePbufferARB;
if (CHECKS) {
check(__functionAddress);
check(hdc);
}
return callPPP(__functionAddress, hdc, pixelFormat, width, height, attribList);
}
/**
* Creates a pixel buffer (pbuffer) and returns a handle to it.
*
* Support for pbuffers may be restricted to specific pixel formats. Use {@link WGLARBPixelFormat#wglGetPixelFormatAttribivARB GetPixelFormatAttribivARB} to query the {@link #WGL_DRAW_TO_PBUFFER_ARB DRAW_TO_PBUFFER_ARB}
* attribute to determine which pixel formats support the creation of pbuffers.
*
* @param hdc a device context for the device on which the pbuffer is created
* @param pixelFormat a non-generic pixel format descriptor index
* @param width the pixel width of the rectangular pbuffer
* @param height the pixel height of the rectangular pbuffer
* @param attribList a 0-terminated list of attributes {type, value} pairs containing integer attribute values
*/
public static long wglCreatePbufferARB(long hdc, int pixelFormat, int width, int height, IntBuffer attribList) {
if (CHECKS) {
checkNTSafe(attribList);
}
return nwglCreatePbufferARB(hdc, pixelFormat, width, height, memAddressSafe(attribList));
}
// --- [ wglGetPbufferDCARB ] ---
/**
* Creates a device context for the pbuffer.
*
* @param pbuffer a pbuffer handle returned from a previous call to {@link #wglCreatePbufferARB CreatePbufferARB}
*/
public static long wglGetPbufferDCARB(long pbuffer) {
long __functionAddress = GL.getCapabilitiesWGL().wglGetPbufferDCARB;
if (CHECKS) {
check(__functionAddress);
check(pbuffer);
}
return callPP(__functionAddress, pbuffer);
}
// --- [ wglReleasePbufferDCARB ] ---
/**
* Releases a device context obtained from a previous call to {@link #wglGetPbufferDCARB GetPbufferDCARB}.
*
* @param pbuffer a pbuffer handle
* @param hdc a device context handle
*/
public static int wglReleasePbufferDCARB(long pbuffer, long hdc) {
long __functionAddress = GL.getCapabilitiesWGL().wglReleasePbufferDCARB;
if (CHECKS) {
check(__functionAddress);
check(pbuffer);
check(hdc);
}
return callPPI(__functionAddress, pbuffer, hdc);
}
// --- [ wglDestroyPbufferARB ] ---
/**
* Destroys a pbuffer.
*
* The pbuffer is destroyed once it is no longer current to any rendering context. When a pbuffer is destroyed, any memory resources that are attached to
* it are freed and its handle is no longer valid.
*
* @param pbuffer a pbuffer handle
*/
public static boolean wglDestroyPbufferARB(long pbuffer) {
long __functionAddress = GL.getCapabilitiesWGL().wglDestroyPbufferARB;
if (CHECKS) {
check(__functionAddress);
check(pbuffer);
}
return callPI(__functionAddress, pbuffer) != 0;
}
// --- [ wglQueryPbufferARB ] ---
/** Unsafe version of: {@link #wglQueryPbufferARB QueryPbufferARB} */
public static int nwglQueryPbufferARB(long pbuffer, int attribute, long value) {
long __functionAddress = GL.getCapabilitiesWGL().wglQueryPbufferARB;
if (CHECKS) {
check(__functionAddress);
check(pbuffer);
}
return callPPI(__functionAddress, pbuffer, attribute, value);
}
/**
* Queries an attribute associated with a specific pbuffer.
*
* @param pbuffer a pbuffer handle
* @param attribute the attribute to query. One of:
{@link #WGL_PBUFFER_WIDTH_ARB PBUFFER_WIDTH_ARB} {@link #WGL_PBUFFER_HEIGHT_ARB PBUFFER_HEIGHT_ARB} {@link #WGL_PBUFFER_LOST_ARB PBUFFER_LOST_ARB}
* @param value the attribute value
*/
public static boolean wglQueryPbufferARB(long pbuffer, int attribute, IntBuffer value) {
if (CHECKS) {
check(value, 1);
}
return nwglQueryPbufferARB(pbuffer, attribute, memAddress(value)) != 0;
}
/** Array version of: {@link #wglCreatePbufferARB CreatePbufferARB} */
public static long wglCreatePbufferARB(long hdc, int pixelFormat, int width, int height, int[] attribList) {
long __functionAddress = GL.getCapabilitiesWGL().wglCreatePbufferARB;
if (CHECKS) {
check(__functionAddress);
check(hdc);
checkNTSafe(attribList);
}
return callPPP(__functionAddress, hdc, pixelFormat, width, height, attribList);
}
/** Array version of: {@link #wglQueryPbufferARB QueryPbufferARB} */
public static boolean wglQueryPbufferARB(long pbuffer, int attribute, int[] value) {
long __functionAddress = GL.getCapabilitiesWGL().wglQueryPbufferARB;
if (CHECKS) {
check(__functionAddress);
check(pbuffer);
check(value, 1);
}
return callPPI(__functionAddress, pbuffer, attribute, value) != 0;
}
}