Package org.lwjgl.opengl

Class WGLARBPixelFormat

java.lang.Object

org.lwjgl.opengl.WGLARBPixelFormat

public class WGLARBPixelFormat
extends java.lang.Object

Native bindings to the WGL_ARB_pixel_format extension.

This extension adds functions to query pixel format attributes and to choose from the list of supported pixel formats.

These functions treat pixel formats as opaque types: attributes are specified by name rather than by accessing them directly as fields in a structure. Thus the list of attributes can be easily extended.

Requires WGL_ARB_extensions_string.

Field Summary

Fields

Modifier and Type	Field and Description
static int	WGL_ACCELERATION_ARB WGL_ACCUM_ALPHA_BITS_ARB WGL_ACCUM_BITS_ARB WGL_ACCUM_BLUE_BITS_ARB WGL_ACCUM_GREEN_BITS_ARB WGL_ACCUM_RED_BITS_ARB WGL_ALPHA_BITS_ARB WGL_ALPHA_SHIFT_ARB WGL_AUX_BUFFERS_ARB WGL_BLUE_BITS_ARB WGL_BLUE_SHIFT_ARB WGL_COLOR_BITS_ARB WGL_DEPTH_BITS_ARB WGL_DOUBLE_BUFFER_ARB WGL_DRAW_TO_BITMAP_ARB WGL_DRAW_TO_WINDOW_ARB Accepted in the attributes parameter array of GetPixelFormatAttribivARB, and GetPixelFormatAttribfvARB, and as a type in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB.
static int	WGL_FULL_ACCELERATION_ARB WGL_GENERIC_ACCELERATION_ARB Accepted as a value in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB, and returned in the values parameter array of GetPixelFormatAttribivARB and GetPixelFormatAttribfvARB.
static int	WGL_GREEN_BITS_ARB WGL_GREEN_SHIFT_ARB WGL_NEED_PALETTE_ARB WGL_NEED_SYSTEM_PALETTE_ARB Accepted in the attributes parameter array of GetPixelFormatAttribivARB, and GetPixelFormatAttribfvARB, and as a type in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB.
static int	WGL_NO_ACCELERATION_ARB Accepted as a value in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB, and returned in the values parameter array of GetPixelFormatAttribivARB and GetPixelFormatAttribfvARB.
static int	WGL_NUMBER_OVERLAYS_ARB WGL_NUMBER_PIXEL_FORMATS_ARB WGL_NUMBER_UNDERLAYS_ARB WGL_PIXEL_TYPE_ARB WGL_RED_BITS_ARB WGL_RED_SHIFT_ARB WGL_SHARE_ACCUM_ARB WGL_SHARE_DEPTH_ARB WGL_SHARE_STENCIL_ARB WGL_STENCIL_BITS_ARB WGL_STEREO_ARB WGL_SUPPORT_GDI_ARB WGL_SUPPORT_OPENGL_ARB Accepted in the attributes parameter array of GetPixelFormatAttribivARB, and GetPixelFormatAttribfvARB, and as a type in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB.
static int	WGL_SWAP_COPY_ARB WGL_SWAP_EXCHANGE_ARB Accepted as a value in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB, and returned in the values parameter array of GetPixelFormatAttribivARB and GetPixelFormatAttribfvARB.
static int	WGL_SWAP_LAYER_BUFFERS_ARB WGL_SWAP_METHOD_ARB Accepted in the attributes parameter array of GetPixelFormatAttribivARB, and GetPixelFormatAttribfvARB, and as a type in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB.
static int	WGL_SWAP_UNDEFINED_ARB Accepted as a value in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB, and returned in the values parameter array of GetPixelFormatAttribivARB and GetPixelFormatAttribfvARB.
static int	WGL_TRANSPARENT_ALPHA_VALUE_ARB WGL_TRANSPARENT_ARB WGL_TRANSPARENT_BLUE_VALUE_ARB WGL_TRANSPARENT_GREEN_VALUE_ARB WGL_TRANSPARENT_INDEX_VALUE_ARB WGL_TRANSPARENT_RED_VALUE_ARB Accepted in the attributes parameter array of GetPixelFormatAttribivARB, and GetPixelFormatAttribfvARB, and as a type in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB.
static int	WGL_TYPE_COLORINDEX_ARB WGL_TYPE_RGBA_ARB Accepted as a value in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB, and returned in the values parameter array of GetPixelFormatAttribivARB and GetPixelFormatAttribfvARB.

Method Summary

Modifier and Type	Method and Description
static boolean	wglChoosePixelFormatARB(long hdc, int[] attribIList, float[] attribFList, int[] formats, int[] numFormats) Array version of: ChoosePixelFormatARB
static boolean	wglChoosePixelFormatARB(long hdc, java.nio.IntBuffer attribIList, java.nio.FloatBuffer attribFList, java.nio.IntBuffer formats, java.nio.IntBuffer numFormats) Selects from among all of the available pixel formats (including both accelerated and generic formats and non-displayable formats).
static boolean	wglGetPixelFormatAttribfARB(long hdc, int pixelFormat, int layerPlane, int attribute, java.nio.FloatBuffer values) Float version of GetPixelFormatAttribivARB.
static boolean	wglGetPixelFormatAttribfvARB(long hdc, int pixelFormat, int layerPlane, int[] attributes, float[] values) Array version of: GetPixelFormatAttribfvARB
static boolean	wglGetPixelFormatAttribfvARB(long hdc, int pixelFormat, int layerPlane, java.nio.IntBuffer attributes, java.nio.FloatBuffer values) Float version of GetPixelFormatAttribivARB.
static boolean	wglGetPixelFormatAttribiARB(long hdc, int pixelFormat, int layerPlane, int attribute, java.nio.IntBuffer values)
static boolean	wglGetPixelFormatAttribivARB(long hdc, int pixelFormat, int layerPlane, int[] attributes, int[] values) Array version of: GetPixelFormatAttribivARB
static boolean	wglGetPixelFormatAttribivARB(long hdc, int pixelFormat, int layerPlane, java.nio.IntBuffer attributes, java.nio.IntBuffer values)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WGL_NUMBER_PIXEL_FORMATS_ARB, WGL_DRAW_TO_WINDOW_ARB, WGL_DRAW_TO_BITMAP_ARB, WGL_ACCELERATION_ARB, WGL_NEED_PALETTE_ARB, WGL_NEED_SYSTEM_PALETTE_ARB, WGL_SWAP_LAYER_BUFFERS_ARB, WGL_SWAP_METHOD_ARB, WGL_NUMBER_OVERLAYS_ARB, WGL_NUMBER_UNDERLAYS_ARB, WGL_TRANSPARENT_ARB, WGL_TRANSPARENT_RED_VALUE_ARB, WGL_TRANSPARENT_GREEN_VALUE_ARB, WGL_TRANSPARENT_BLUE_VALUE_ARB, WGL_TRANSPARENT_ALPHA_VALUE_ARB, WGL_TRANSPARENT_INDEX_VALUE_ARB, WGL_SHARE_DEPTH_ARB, WGL_SHARE_STENCIL_ARB, WGL_SHARE_ACCUM_ARB, WGL_SUPPORT_GDI_ARB, WGL_SUPPORT_OPENGL_ARB, WGL_DOUBLE_BUFFER_ARB, WGL_STEREO_ARB, WGL_PIXEL_TYPE_ARB, WGL_COLOR_BITS_ARB, WGL_RED_BITS_ARB, WGL_RED_SHIFT_ARB, WGL_GREEN_BITS_ARB, WGL_GREEN_SHIFT_ARB, WGL_BLUE_BITS_ARB, WGL_BLUE_SHIFT_ARB, WGL_ALPHA_BITS_ARB, WGL_ALPHA_SHIFT_ARB, WGL_ACCUM_BITS_ARB, WGL_ACCUM_RED_BITS_ARB, WGL_ACCUM_GREEN_BITS_ARB, WGL_ACCUM_BLUE_BITS_ARB, WGL_ACCUM_ALPHA_BITS_ARB, WGL_DEPTH_BITS_ARB, WGL_STENCIL_BITS_ARB, WGL_AUX_BUFFERS_ARB

Accepted in the attributes parameter array of GetPixelFormatAttribivARB, and GetPixelFormatAttribfvARB, and as a type in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB.

WGL_NO_ACCELERATION_ARB, WGL_GENERIC_ACCELERATION_ARB, WGL_FULL_ACCELERATION_ARB, WGL_SWAP_EXCHANGE_ARB, WGL_SWAP_COPY_ARB, WGL_SWAP_UNDEFINED_ARB, WGL_TYPE_RGBA_ARB, WGL_TYPE_COLORINDEX_ARB

Accepted as a value in the attribIList and attribFList parameter arrays of ChoosePixelFormatARB, and returned in the values parameter array of GetPixelFormatAttribivARB and GetPixelFormatAttribfvARB.

Method Detail

wglGetPixelFormatAttribivARB

public static boolean wglGetPixelFormatAttribivARB(long hdc,
                                                   int pixelFormat,
                                                   int layerPlane,
                                                   java.nio.IntBuffer attributes,
                                                   java.nio.IntBuffer values)

Parameters:

hdc - the device context on which the pixel format is supported

pixelFormat - an index that specifies the pixel format

layerPlane - the plane being queried

attributes - an array of pixel format attribute identifiers which specify the attributes to be queried. One of:

NUMBER_PIXEL_FORMATS_ARB	DRAW_TO_WINDOW_ARB	DRAW_TO_BITMAP_ARB	ACCELERATION_ARB
NEED_PALETTE_ARB	NEED_SYSTEM_PALETTE_ARB	SWAP_LAYER_BUFFERS_ARB	SWAP_METHOD_ARB
NUMBER_OVERLAYS_ARB	NUMBER_UNDERLAYS_ARB	TRANSPARENT_ARB	TRANSPARENT_RED_VALUE_ARB
TRANSPARENT_GREEN_VALUE_ARB	TRANSPARENT_BLUE_VALUE_ARB	TRANSPARENT_ALPHA_VALUE_ARB	TRANSPARENT_INDEX_VALUE_ARB
SHARE_DEPTH_ARB	SHARE_STENCIL_ARB	SHARE_ACCUM_ARB	SUPPORT_GDI_ARB
SUPPORT_OPENGL_ARB	DOUBLE_BUFFER_ARB	STEREO_ARB	PIXEL_TYPE_ARB
COLOR_BITS_ARB	RED_BITS_ARB	RED_SHIFT_ARB	GREEN_BITS_ARB
GREEN_SHIFT_ARB	BLUE_BITS_ARB	BLUE_SHIFT_ARB	ALPHA_BITS_ARB
ALPHA_SHIFT_ARB	ACCUM_BITS_ARB	ACCUM_RED_BITS_ARB	ACCUM_GREEN_BITS_ARB
ACCUM_BLUE_BITS_ARB	ACCUM_ALPHA_BITS_ARB	DEPTH_BITS_ARB	STENCIL_BITS_ARB
AUX_BUFFERS_ARB

values - a buffer into which the results of the query will be placed

wglGetPixelFormatAttribiARB

public static boolean wglGetPixelFormatAttribiARB(long hdc,
                                                  int pixelFormat,
                                                  int layerPlane,
                                                  int attribute,
                                                  java.nio.IntBuffer values)

Parameters:

hdc - the device context on which the pixel format is supported

pixelFormat - an index that specifies the pixel format

layerPlane - the plane being queried

values - a buffer into which the results of the query will be placed

wglGetPixelFormatAttribfvARB

public static boolean wglGetPixelFormatAttribfvARB(long hdc,
                                                   int pixelFormat,
                                                   int layerPlane,
                                                   java.nio.IntBuffer attributes,
                                                   java.nio.FloatBuffer values)

Float version of GetPixelFormatAttribivARB.

Parameters:

hdc - the device context on which the pixel format is supported

pixelFormat - an index that specifies the pixel format

layerPlane - the plane being queried

attributes - an array of pixel format attribute identifiers which specify the attributes to be queried

values - a buffer into which the results of the query will be placed

wglGetPixelFormatAttribfARB

public static boolean wglGetPixelFormatAttribfARB(long hdc,
                                                  int pixelFormat,
                                                  int layerPlane,
                                                  int attribute,
                                                  java.nio.FloatBuffer values)

Float version of GetPixelFormatAttribivARB.

Parameters:

hdc - the device context on which the pixel format is supported

pixelFormat - an index that specifies the pixel format

layerPlane - the plane being queried

values - a buffer into which the results of the query will be placed

wglChoosePixelFormatARB

public static boolean wglChoosePixelFormatARB(long hdc,
                                              java.nio.IntBuffer attribIList,
                                              java.nio.FloatBuffer attribFList,
                                              java.nio.IntBuffer formats,
                                              java.nio.IntBuffer numFormats)

Selects from among all of the available pixel formats (including both accelerated and generic formats and non-displayable formats). This function accepts attributes for the main planes. A list of pixel formats that match the specified attributes is returned with the "best" pixel formats at the start of the list (order is device dependent).

Parameters:

hdc - the device context on which the pixel format is supported

attribIList - a list of attribute {type, value} pairs containing integer attribute values. One of:

NUMBER_PIXEL_FORMATS_ARB	DRAW_TO_WINDOW_ARB	DRAW_TO_BITMAP_ARB	ACCELERATION_ARB
NEED_PALETTE_ARB	NEED_SYSTEM_PALETTE_ARB	SWAP_LAYER_BUFFERS_ARB	SWAP_METHOD_ARB
NUMBER_OVERLAYS_ARB	NUMBER_UNDERLAYS_ARB	TRANSPARENT_ARB	TRANSPARENT_RED_VALUE_ARB
TRANSPARENT_GREEN_VALUE_ARB	TRANSPARENT_BLUE_VALUE_ARB	TRANSPARENT_ALPHA_VALUE_ARB	TRANSPARENT_INDEX_VALUE_ARB
SHARE_DEPTH_ARB	SHARE_STENCIL_ARB	SHARE_ACCUM_ARB	SUPPORT_GDI_ARB
SUPPORT_OPENGL_ARB	DOUBLE_BUFFER_ARB	STEREO_ARB	PIXEL_TYPE_ARB
COLOR_BITS_ARB	RED_BITS_ARB	RED_SHIFT_ARB	GREEN_BITS_ARB
GREEN_SHIFT_ARB	BLUE_BITS_ARB	BLUE_SHIFT_ARB	ALPHA_BITS_ARB
ALPHA_SHIFT_ARB	ACCUM_BITS_ARB	ACCUM_RED_BITS_ARB	ACCUM_GREEN_BITS_ARB
ACCUM_BLUE_BITS_ARB	ACCUM_ALPHA_BITS_ARB	DEPTH_BITS_ARB	STENCIL_BITS_ARB
AUX_BUFFERS_ARB

attribFList - a list of attribute {type, value} pairs containing floating point attribute values

formats - an array of returned indices of the matching pixel formats. The best pixel formats (i.e. closest match and best format for the hardware) are at the head of the list.

numFormats - returns the number of matching formats

wglGetPixelFormatAttribivARB

public static boolean wglGetPixelFormatAttribivARB(long hdc,
                                                   int pixelFormat,
                                                   int layerPlane,
                                                   int[] attributes,
                                                   int[] values)

Array version of: GetPixelFormatAttribivARB

wglGetPixelFormatAttribfvARB

public static boolean wglGetPixelFormatAttribfvARB(long hdc,
                                                   int pixelFormat,
                                                   int layerPlane,
                                                   int[] attributes,
                                                   float[] values)

Array version of: GetPixelFormatAttribfvARB

wglChoosePixelFormatARB

public static boolean wglChoosePixelFormatARB(long hdc,
                                              int[] attribIList,
                                              float[] attribFList,
                                              int[] formats,
                                              int[] numFormats)

Array version of: ChoosePixelFormatARB