Top Description Inners Fields Constructors Methods
org.lwjgl.glfw

public Class GLFWVidMode

extends Struct<GLFWVidMode>
Class Inheritance
Annotations
@NativeType:struct GLFWvidmode
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Describes a single video mode.

Layout


struct GLFWvidmode {
    int width;
    int height;
    int redBits;
    int greenBits;
    int blueBits;
    int refreshRate;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
GLFWVidMode.Buffer

An array of GLFWVidMode structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BLUEBITS

The struct member offsets.

public static final int
GREENBITS

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
REDBITS

The struct member offsets.

public static final int
REFRESHRATE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
GLFWVidMode(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
blueBits()

the bit depth of the blue channel of the video mode

protected GLFWVidMode
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 GLFWVidMode
create(long address)

Returns a new GLFWVidMode instance for the specified memory address.

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

Create a GLFWVidMode.Buffer instance at the specified memory.

public static GLFWVidMode
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
greenBits()

the bit depth of the green channel of the video mode

public int
height()

the height, in screen coordinates, of the video mode

public static int
nblueBits(long struct)

Unsafe version of blueBits.

public static int
ngreenBits(long struct)

Unsafe version of greenBits.

public static int
nheight(long struct)

Unsafe version of height.

public static int
nredBits(long struct)

Unsafe version of redBits.

public static int
nrefreshRate(long struct)

Unsafe version of refreshRate.

public static int
nwidth(long struct)

Unsafe version of width.

public int
redBits()

the bit depth of the red channel of the video mode

public int
refreshRate()

the refresh rate, in Hz, of the video mode

public int
sizeof()

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

Returns sizeof(struct).
public int
width()

the width, in screen coordinates, of the video mode

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BLUEBITSback to summary
public static final int BLUEBITS

The struct member offsets.

GREENBITSback to summary
public static final int GREENBITS

The struct member offsets.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

REDBITSback to summary
public static final int REDBITS

The struct member offsets.

REFRESHRATEback to summary
public static final int REFRESHRATE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

GLFWVidModeback to summary
protected GLFWVidMode(long address, ByteBuffer container)
GLFWVidModeback to summary
public GLFWVidMode(ByteBuffer container)

Creates a GLFWVidMode instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

blueBitsback to summary
public int blueBits()

the bit depth of the blue channel of the video mode

createback to summary
protected GLFWVidMode create(long address, ByteBuffer container)

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

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static GLFWVidMode create(long address)

Returns a new GLFWVidMode instance for the specified memory address.

createback to summary
public static GLFWVidMode.Buffer create(long address, int capacity)

Create a GLFWVidMode.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static GLFWVidMode createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static GLFWVidMode.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
greenBitsback to summary
public int greenBits()

the bit depth of the green channel of the video mode

heightback to summary
public int height()

the height, in screen coordinates, of the video mode

nblueBitsback to summary
public static int nblueBits(long struct)

Unsafe version of blueBits.

ngreenBitsback to summary
public static int ngreenBits(long struct)

Unsafe version of greenBits.

nheightback to summary
public static int nheight(long struct)

Unsafe version of height.

nredBitsback to summary
public static int nredBits(long struct)

Unsafe version of redBits.

nrefreshRateback to summary
public static int nrefreshRate(long struct)

Unsafe version of refreshRate.

nwidthback to summary
public static int nwidth(long struct)

Unsafe version of width.

redBitsback to summary
public int redBits()

the bit depth of the red channel of the video mode

refreshRateback to summary
public int refreshRate()

the refresh rate, in Hz, of the video mode

sizeofback to summary
public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
widthback to summary
public int width()

the width, in screen coordinates, of the video mode

org.lwjgl.glfw back to summary

public Class GLFWVidMode.Buffer

extends StructBuffer<GLFWVidMode, GLFWVidMode.Buffer>
Class Inheritance

An array of GLFWVidMode structs.

Field Summary

Modifier and TypeField and Description
private static final GLFWVidMode

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new GLFWVidMode.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the GLFWVidMode#blueBits field.
blueBits
()

protected GLFWVidMode
public int

Returns:

the value of the GLFWVidMode#greenBits field.
greenBits
()

public int

Returns:

the value of the GLFWVidMode#height field.
height
()

public int

Returns:

the value of the GLFWVidMode#redBits field.
redBits
()

public int

Returns:

the value of the GLFWVidMode#refreshRate field.
refreshRate
()

protected GLFWVidMode.Buffer
public int

Returns:

the value of the GLFWVidMode#width field.
width
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final GLFWVidMode ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new GLFWVidMode.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by GLFWVidMode#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

blueBitsback to summary
public int blueBits()
Returns:int

the value of the GLFWVidMode#blueBits field.

getElementFactoryback to summary
protected GLFWVidMode getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
greenBitsback to summary
public int greenBits()
Returns:int

the value of the GLFWVidMode#greenBits field.

heightback to summary
public int height()
Returns:int

the value of the GLFWVidMode#height field.

redBitsback to summary
public int redBits()
Returns:int

the value of the GLFWVidMode#redBits field.

refreshRateback to summary
public int refreshRate()
Returns:int

the value of the GLFWVidMode#refreshRate field.

selfback to summary
protected GLFWVidMode.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
widthback to summary
public int width()
Returns:int

the value of the GLFWVidMode#width field.