Module overrungl.glfw

Package overrungl.glfw

Class GLFWVidMode

java.lang.Object

overrungl.Pointer

overrungl.Struct

overrungl.glfw.GLFWVidMode

All Implemented Interfaces:

Addressable

Direct Known Subclasses:

GLFWVidMode.Buffer

public class GLFWVidMode
extends Struct

GLFWVidMode relies on preview features of the Java platform:

• GLFWVidMode refers to one or more preview APIs: MemoryLayout, MemorySegment, SegmentAllocator, StructLayout.

Programs can only use GLFWVidMode when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

This describes a single video mode.

Layout

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

Since:

0.1.0

Author:

squid233

See Also:

• GLFW.getVideoMode(java.lang.foreign.MemorySegment)^PREVIEW
• GLFW.getVideoModes(java.lang.foreign.SegmentAllocator, java.lang.foreign.MemorySegment)^PREVIEW

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GLFWVidMode.Buffer	This describes video modes.
static final record	GLFWVidMode.Value	The immutable state of GLFWVidMode.

Field Summary

Fields

Modifier and Type	Field	Description
static final StructLayoutPREVIEW	LAYOUT	The struct layout.

Fields inherited from class overrungl.Struct

layout

Fields inherited from class overrungl.Pointer

address, allocator, managedSegment

Constructor Summary

Constructors

Modifier	Constructor	Description
	GLFWVidMode(MemorySegmentPREVIEW address, SegmentAllocatorPREVIEW allocator)	Create a GLFWvidmode instance.
protected	GLFWVidMode(MemorySegmentPREVIEW address, SegmentAllocatorPREVIEW allocator, MemoryLayoutPREVIEW layout)	Creates a struct instance with the given memory layout.

Method Summary

Modifier and Type	Method	Description
int	blueBits()	Returns the bit depth of the blue channel of the video mode.
static GLFWVidMode	create(SegmentAllocatorPREVIEW allocator)	Creates a GLFWVidMode instance with the given allocator.
static GLFWVidMode.Buffer	create(SegmentAllocatorPREVIEW allocator, long count)	Creates a GLFWVidMode.Buffer instance with the given allocator and count.
int	greenBits()	Returns the bit depth of the green channel of the video mode.
int	height()	Returns the height, in screen coordinates, of the video mode.
int	redBits()	Returns the bit depth of the red channel of the video mode.
int	refreshRate()	Returns the refresh rate, in Hz, of the video mode.
GLFWVidMode.Value	value()	Returns an immutable state of this struct.
int	width()	Returns the width, in screen coordinates, of the video mode.

Methods inherited from class overrungl.Struct

layout, segment, sizeof

Methods inherited from class overrungl.Pointer

address, allocator, segment, segment

Methods inherited from class java.lang.Object

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

Field Details

LAYOUT

public static final StructLayoutPREVIEW LAYOUT

The struct layout.

Constructor Details

GLFWVidMode

public GLFWVidMode(MemorySegmentPREVIEW address,
 SegmentAllocatorPREVIEW allocator)

Create a GLFWvidmode instance.

Parameters:

address - the address.

allocator - the allocator of this address.

GLFWVidMode

protected GLFWVidMode(MemorySegmentPREVIEW address,
 SegmentAllocatorPREVIEW allocator,
 MemoryLayoutPREVIEW layout)

Creates a struct instance with the given memory layout.

Parameters:

address - the address.

allocator - the allocator of this address.

layout - the memory layout of this struct.

Method Details

create

public static GLFWVidMode create(SegmentAllocatorPREVIEW allocator)

Creates a GLFWVidMode instance with the given allocator.

Parameters:

allocator - the allocator

Returns:

the instance

create

public static GLFWVidMode.Buffer create(SegmentAllocatorPREVIEW allocator,
 long count)

Creates a GLFWVidMode.Buffer instance with the given allocator and count.

Parameters:

allocator - the allocator

count - the count

Returns:

the instance

value

public GLFWVidMode.Value value()

Returns an immutable state of this struct.

Returns:

an immutable state of this struct

width

public int width()

Returns the width, in screen coordinates, of the video mode.

Returns:

the width, in screen coordinates, of the video mode

height

public int height()

Returns the height, in screen coordinates, of the video mode.

Returns:

the height, in screen coordinates, of the video mode

redBits

public int redBits()

Returns the bit depth of the red channel of the video mode.

Returns:

the bit depth of the red channel of the video mode

greenBits

public int greenBits()

Returns the bit depth of the green channel of the video mode.

Returns:

the bit depth of the green channel of the video mode

blueBits

public int blueBits()

Returns the bit depth of the blue channel of the video mode.

Returns:

the bit depth of the blue channel of the video mode

refreshRate

public int refreshRate()

Returns the refresh rate, in Hz, of the video mode.

Returns:

the refresh rate, in Hz, of the video mode