Top Description Inners Fields Constructors Methods
org.lwjgl.system.windows

public Class PIXELFORMATDESCRIPTOR

extends Struct<PIXELFORMATDESCRIPTOR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Describes the pixel format of a drawing surface.

Layout


struct PIXELFORMATDESCRIPTOR {
    WORD nSize;
    WORD nVersion;
    DWORD dwFlags;
    BYTE iPixelType;
    BYTE cColorBits;
    BYTE cRedBits;
    BYTE cRedShift;
    BYTE cGreenBits;
    BYTE cGreenShift;
    BYTE cBlueBits;
    BYTE cBlueShift;
    BYTE cAlphaBits;
    BYTE cAlphaShift;
    BYTE cAccumBits;
    BYTE cAccumRedBits;
    BYTE cAccumGreenBits;
    BYTE cAccumBlueBits;
    BYTE cAccumAlphaBits;
    BYTE cDepthBits;
    BYTE cStencilBits;
    BYTE cAuxBuffers;
    BYTE iLayerType;
    BYTE bReserved;
    DWORD dwLayerMask;
    DWORD dwVisibleMask;
    DWORD dwDamageMask;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
PIXELFORMATDESCRIPTOR.Buffer

An array of PIXELFORMATDESCRIPTOR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BRESERVED

The struct member offsets.

public static final int
CACCUMALPHABITS

The struct member offsets.

public static final int
CACCUMBITS

The struct member offsets.

public static final int
CACCUMBLUEBITS

The struct member offsets.

public static final int
CACCUMGREENBITS

The struct member offsets.

public static final int
CACCUMREDBITS

The struct member offsets.

public static final int
CALPHABITS

The struct member offsets.

public static final int
CALPHASHIFT

The struct member offsets.

public static final int
CAUXBUFFERS

The struct member offsets.

public static final int
CBLUEBITS

The struct member offsets.

public static final int
CBLUESHIFT

The struct member offsets.

public static final int
CCOLORBITS

The struct member offsets.

public static final int
CDEPTHBITS

The struct member offsets.

public static final int
CGREENBITS

The struct member offsets.

public static final int
CGREENSHIFT

The struct member offsets.

public static final int
CREDBITS

The struct member offsets.

public static final int
CREDSHIFT

The struct member offsets.

public static final int
CSTENCILBITS

The struct member offsets.

public static final int
DWDAMAGEMASK

The struct member offsets.

public static final int
DWFLAGS

The struct member offsets.

public static final int
DWLAYERMASK

The struct member offsets.

public static final int
DWVISIBLEMASK

The struct member offsets.

public static final int
ILAYERTYPE

The struct member offsets.

public static final int
IPIXELTYPE

The struct member offsets.

public static final int
NSIZE

The struct member offsets.

public static final int
NVERSION

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
PIXELFORMATDESCRIPTOR(long address, ByteBuffer container)

public
PIXELFORMATDESCRIPTOR(ByteBuffer container)

Creates a PIXELFORMATDESCRIPTOR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public byte
bReserved()

specifies the number of overlay and underlay planes.

public PIXELFORMATDESCRIPTOR
bReserved(byte value)

Sets the specified value to the bReserved field.

public byte
cAccumAlphaBits()

specifies the number of alpha bitplanes in the accumulation buffer

public PIXELFORMATDESCRIPTOR
cAccumAlphaBits(byte value)

Sets the specified value to the cAccumAlphaBits field.

public byte
cAccumBits()

specifies the total number of bitplanes in the accumulation buffer

public PIXELFORMATDESCRIPTOR
cAccumBits(byte value)

Sets the specified value to the cAccumBits field.

public byte
cAccumBlueBits()

specifies the number of blue bitplanes in the accumulation buffer

public PIXELFORMATDESCRIPTOR
cAccumBlueBits(byte value)

Sets the specified value to the cAccumBlueBits field.

public byte
cAccumGreenBits()

specifies the number of green bitplanes in the accumulation buffer

public PIXELFORMATDESCRIPTOR
cAccumGreenBits(byte value)

Sets the specified value to the cAccumGreenBits field.

public byte
cAccumRedBits()

specifies the number of red bitplanes in the accumulation buffer

public PIXELFORMATDESCRIPTOR
cAccumRedBits(byte value)

Sets the specified value to the cAccumRedBits field.

public static PIXELFORMATDESCRIPTOR
calloc()

Returns a new PIXELFORMATDESCRIPTOR instance allocated with memCalloc.

public static PIXELFORMATDESCRIPTOR.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new PIXELFORMATDESCRIPTOR.Buffer instance allocated with memCalloc.

public static PIXELFORMATDESCRIPTOR
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new PIXELFORMATDESCRIPTOR instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static PIXELFORMATDESCRIPTOR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new PIXELFORMATDESCRIPTOR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static PIXELFORMATDESCRIPTOR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static PIXELFORMATDESCRIPTOR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static PIXELFORMATDESCRIPTOR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static PIXELFORMATDESCRIPTOR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public byte
cAlphaBits()

specifies the number of alpha bitplanes in each RGBA color buffer.

public PIXELFORMATDESCRIPTOR
cAlphaBits(byte value)

Sets the specified value to the cAlphaBits field.

public byte
cAlphaShift()

specifies the shift count for alpha bitplanes in each RGBA color buffer.

public PIXELFORMATDESCRIPTOR
cAlphaShift(byte value)

Sets the specified value to the cAlphaShift field.

public byte
cAuxBuffers()

specifies the number of auxiliary buffers.

public PIXELFORMATDESCRIPTOR
cAuxBuffers(byte value)

Sets the specified value to the cAuxBuffers field.

public byte
cBlueBits()

specifies the number of blue bitplanes in each RGBA color buffer

public PIXELFORMATDESCRIPTOR
cBlueBits(byte value)

Sets the specified value to the cBlueBits field.

public byte
cBlueShift()

specifies the shift count for blue bitplanes in each RGBA color buffer

public PIXELFORMATDESCRIPTOR
cBlueShift(byte value)

Sets the specified value to the cBlueShift field.

public byte
cColorBits()

specifies the number of color bitplanes in each color buffer.

public PIXELFORMATDESCRIPTOR
cColorBits(byte value)

Sets the specified value to the cColorBits field.

public byte
cDepthBits()

specifies the depth of the depth (z-axis) buffer

public PIXELFORMATDESCRIPTOR
cDepthBits(byte value)

Sets the specified value to the cDepthBits field.

public byte
cGreenBits()

specifies the number of green bitplanes in each RGBA color buffer

public PIXELFORMATDESCRIPTOR
cGreenBits(byte value)

Sets the specified value to the cGreenBits field.

public byte
cGreenShift()

specifies the shift count for green bitplanes in each RGBA color buffer

public PIXELFORMATDESCRIPTOR
cGreenShift(byte value)

Sets the specified value to the cGreenShift field.

protected PIXELFORMATDESCRIPTOR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static PIXELFORMATDESCRIPTOR
create()

Returns a new PIXELFORMATDESCRIPTOR instance allocated with BufferUtils.

public static PIXELFORMATDESCRIPTOR
create(long address)

Returns a new PIXELFORMATDESCRIPTOR instance for the specified memory address.

public static PIXELFORMATDESCRIPTOR.Buffer
create(int
the buffer capacity
capacity)

Returns a new PIXELFORMATDESCRIPTOR.Buffer instance allocated with BufferUtils.

public static PIXELFORMATDESCRIPTOR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a PIXELFORMATDESCRIPTOR.Buffer instance at the specified memory.

public static PIXELFORMATDESCRIPTOR
createSafe(long address)

Like create, but returns null if address is NULL.

public static PIXELFORMATDESCRIPTOR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public byte
cRedBits()

specifies the number of red bitplanes in each RGBA color buffer

public PIXELFORMATDESCRIPTOR
cRedBits(byte value)

Sets the specified value to the cRedBits field.

public byte
cRedShift()

specifies the shift count for red bitplanes in each RGBA color buffer

public PIXELFORMATDESCRIPTOR
cRedShift(byte value)

Sets the specified value to the cRedShift field.

public byte
cStencilBits()

specifies the depth of the stencil buffer

public PIXELFORMATDESCRIPTOR
cStencilBits(byte value)

Sets the specified value to the cStencilBits field.

public int
dwDamageMask()

Ignored.

public PIXELFORMATDESCRIPTOR
dwDamageMask(int value)

Sets the specified value to the dwDamageMask field.

public int
dwFlags()

a set of bit flags that specify properties of the pixel buffer

public PIXELFORMATDESCRIPTOR
dwFlags(int value)

Sets the specified value to the dwFlags field.

public int
dwLayerMask()

Ignored.

public PIXELFORMATDESCRIPTOR
dwLayerMask(int value)

Sets the specified value to the dwLayerMask field.

public int
dwVisibleMask()

specifies the transparent color or index of an underlay plane.

public PIXELFORMATDESCRIPTOR
dwVisibleMask(int value)

Sets the specified value to the dwVisibleMask field.

public byte
iLayerType()

Ignored.

public PIXELFORMATDESCRIPTOR
iLayerType(byte value)

Sets the specified value to the iLayerType field.

public byte
iPixelType()

specifies the type of pixel data

public PIXELFORMATDESCRIPTOR
iPixelType(byte value)

Sets the specified value to the iPixelType field.

public static PIXELFORMATDESCRIPTOR
malloc()

Returns a new PIXELFORMATDESCRIPTOR instance allocated with memAlloc.

public static PIXELFORMATDESCRIPTOR.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new PIXELFORMATDESCRIPTOR.Buffer instance allocated with memAlloc.

public static PIXELFORMATDESCRIPTOR
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new PIXELFORMATDESCRIPTOR instance allocated on the specified MemoryStack.

public static PIXELFORMATDESCRIPTOR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new PIXELFORMATDESCRIPTOR.Buffer instance allocated on the specified MemoryStack.

public static PIXELFORMATDESCRIPTOR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static PIXELFORMATDESCRIPTOR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static PIXELFORMATDESCRIPTOR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static PIXELFORMATDESCRIPTOR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static byte
nbReserved(long struct)

Unsafe version of bReserved.

public static void
nbReserved(long struct, byte value)

Unsafe version of bReserved.

public static byte
ncAccumAlphaBits(long struct)

Unsafe version of cAccumAlphaBits.

public static void
ncAccumAlphaBits(long struct, byte value)

Unsafe version of cAccumAlphaBits.

public static byte
ncAccumBits(long struct)

Unsafe version of cAccumBits.

public static void
ncAccumBits(long struct, byte value)

Unsafe version of cAccumBits.

public static byte
ncAccumBlueBits(long struct)

Unsafe version of cAccumBlueBits.

public static void
ncAccumBlueBits(long struct, byte value)

Unsafe version of cAccumBlueBits.

public static byte
ncAccumGreenBits(long struct)

Unsafe version of cAccumGreenBits.

public static void
ncAccumGreenBits(long struct, byte value)

Unsafe version of cAccumGreenBits.

public static byte
ncAccumRedBits(long struct)

Unsafe version of cAccumRedBits.

public static void
ncAccumRedBits(long struct, byte value)

Unsafe version of cAccumRedBits.

public static byte
ncAlphaBits(long struct)

Unsafe version of cAlphaBits.

public static void
ncAlphaBits(long struct, byte value)

Unsafe version of cAlphaBits.

public static byte
ncAlphaShift(long struct)

Unsafe version of cAlphaShift.

public static void
ncAlphaShift(long struct, byte value)

Unsafe version of cAlphaShift.

public static byte
ncAuxBuffers(long struct)

Unsafe version of cAuxBuffers.

public static void
ncAuxBuffers(long struct, byte value)

Unsafe version of cAuxBuffers.

public static byte
ncBlueBits(long struct)

Unsafe version of cBlueBits.

public static void
ncBlueBits(long struct, byte value)

Unsafe version of cBlueBits.

public static byte
ncBlueShift(long struct)

Unsafe version of cBlueShift.

public static void
ncBlueShift(long struct, byte value)

Unsafe version of cBlueShift.

public static byte
ncColorBits(long struct)

Unsafe version of cColorBits.

public static void
ncColorBits(long struct, byte value)

Unsafe version of cColorBits.

public static byte
ncDepthBits(long struct)

Unsafe version of cDepthBits.

public static void
ncDepthBits(long struct, byte value)

Unsafe version of cDepthBits.

public static byte
ncGreenBits(long struct)

Unsafe version of cGreenBits.

public static void
ncGreenBits(long struct, byte value)

Unsafe version of cGreenBits.

public static byte
ncGreenShift(long struct)

Unsafe version of cGreenShift.

public static void
ncGreenShift(long struct, byte value)

Unsafe version of cGreenShift.

public static byte
ncRedBits(long struct)

Unsafe version of cRedBits.

public static void
ncRedBits(long struct, byte value)

Unsafe version of cRedBits.

public static byte
ncRedShift(long struct)

Unsafe version of cRedShift.

public static void
ncRedShift(long struct, byte value)

Unsafe version of cRedShift.

public static byte
ncStencilBits(long struct)

Unsafe version of cStencilBits.

public static void
ncStencilBits(long struct, byte value)

Unsafe version of cStencilBits.

public static int
ndwDamageMask(long struct)

Unsafe version of dwDamageMask.

public static void
ndwDamageMask(long struct, int value)

Unsafe version of dwDamageMask.

public static int
ndwFlags(long struct)

Unsafe version of dwFlags.

public static void
ndwFlags(long struct, int value)

Unsafe version of dwFlags.

public static int
ndwLayerMask(long struct)

Unsafe version of dwLayerMask.

public static void
ndwLayerMask(long struct, int value)

Unsafe version of dwLayerMask.

public static int
ndwVisibleMask(long struct)

Unsafe version of dwVisibleMask.

public static void
ndwVisibleMask(long struct, int value)

Unsafe version of dwVisibleMask.

public static byte
niLayerType(long struct)

Unsafe version of iLayerType.

public static void
niLayerType(long struct, byte value)

Unsafe version of iLayerType.

public static byte
niPixelType(long struct)

Unsafe version of iPixelType.

public static void
niPixelType(long struct, byte value)

Unsafe version of iPixelType.

public static short
nnSize(long struct)

Unsafe version of nSize.

public static void
nnSize(long struct, short value)

Unsafe version of nSize.

public static short
nnVersion(long struct)

Unsafe version of nVersion.

public static void
nnVersion(long struct, short value)

Unsafe version of nVersion.

public short
nSize()

specifies the size of this data structure.

public PIXELFORMATDESCRIPTOR
nSize(short value)

Sets the specified value to the nSize field.

public short
nVersion()

specifies the version of this data structure.

public PIXELFORMATDESCRIPTOR
nVersion(short value)

Sets the specified value to the nVersion field.

public PIXELFORMATDESCRIPTOR
set(short nSize, short nVersion, int dwFlags, byte iPixelType, byte cColorBits, byte cRedBits, byte cRedShift, byte cGreenBits, byte cGreenShift, byte cBlueBits, byte cBlueShift, byte cAlphaBits, byte cAlphaShift, byte cAccumBits, byte cAccumRedBits, byte cAccumGreenBits, byte cAccumBlueBits, byte cAccumAlphaBits, byte cDepthBits, byte cStencilBits, byte cAuxBuffers, byte iLayerType, byte bReserved, int dwLayerMask, int dwVisibleMask, int dwDamageMask)

Initializes this struct with the specified values.

public PIXELFORMATDESCRIPTOR

Returns:

this struct
set(PIXELFORMATDESCRIPTOR
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate