Class GLFWRenderModuleKeyboardInput

java.lang.Object

io.codetoil.curved_spacetime.render.glfw.GLFWRenderModuleKeyboardInput

All Implemented Interfaces:

RenderModuleKeyboardInput, org.lwjgl.glfw.GLFWKeyCallbackI, org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer

public class GLFWRenderModuleKeyboardInput
extends Object
implements RenderModuleKeyboardInput, org.lwjgl.glfw.GLFWKeyCallbackI

Keyboard input backed by GLFW.

Held state and tapped state come from different places: keyPressed(RenderModuleKeyboardInput.KeyCtx) asks GLFW directly, while keyTapped(RenderModuleKeyboardInput.KeyCtx) reads a map this class maintains from GLFW's key callback, since a tap is an edge that polling would miss. That map is cleared each frame by clean(), so a tap is reported for exactly one frame.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GLFWRenderModuleKeyboardInput.KeyCtx	A key identified the way GLFW reports it.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Nested classes/interfaces inherited from interface RenderModuleKeyboardInput

RenderModuleKeyboardInput.KeyCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<RenderModuleKeyboardInput.KeyCallback>	callbacks	Listeners notified whenever a key changes state.
protected final Map<Integer,Boolean>	tappedKeyMap	Which keys went down since the last clean(), keyed by GLFW key code.
protected final GLFWRenderModuleWindow	window	The window this input reads from.

Fields inherited from interface org.lwjgl.glfw.GLFWKeyCallbackI

DESCRIPTOR

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
GLFWRenderModuleKeyboardInput(GLFWRenderModuleWindow window)	Attaches keyboard handling to the given window.

Method Summary

Modifier and Type	Method	Description
void	addKeyCallBack(RenderModuleKeyboardInput.KeyCallback callback)	Registers a callback invoked when a key changes state.
void	clean()	Clears per-frame state, so that tapped keys are not reported twice.
void	invoke(long handle, int keyCode, int scanCode, int action, int mods)	Records a key change from GLFW and notifies the registered callbacks.
boolean	keyPressed(RenderModuleKeyboardInput.KeyCtx keyCtx)	Returns whether a key is currently held down.
boolean	keyTapped(RenderModuleKeyboardInput.KeyCtx keyCtx)	Returns whether a key went down during the frame just sampled.
void	poll()	Samples the keyboard, refreshing what the query methods report.
RenderModuleWindow	window()	Returns the window this input reads from.

Methods inherited from class Object

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

Methods inherited from interface org.lwjgl.system.CallbackI

address

Methods inherited from interface org.lwjgl.glfw.GLFWKeyCallbackI

callback, getDescriptor

Field Details

tappedKeyMap

protected final Map<Integer,Boolean> tappedKeyMap

Which keys went down since the last clean(), keyed by GLFW key code.

window

protected final GLFWRenderModuleWindow window

The window this input reads from.

callbacks

protected final List<RenderModuleKeyboardInput.KeyCallback> callbacks

Listeners notified whenever a key changes state.

Constructor Details

GLFWRenderModuleKeyboardInput

public GLFWRenderModuleKeyboardInput(GLFWRenderModuleWindow window)

Attaches keyboard handling to the given window.

Installs a GLFW key callback, replacing any previously set on that window.

Parameters:

window - the window to read keyboard input from

Method Details

window

public RenderModuleWindow window()

Description copied from interface: RenderModuleKeyboardInput

Returns the window this input reads from.

Specified by:

window in interface RenderModuleKeyboardInput

Returns:

the owning window

addKeyCallBack

public void addKeyCallBack(RenderModuleKeyboardInput.KeyCallback callback)

Description copied from interface: RenderModuleKeyboardInput

Registers a callback invoked when a key changes state.

Specified by:

addKeyCallBack in interface RenderModuleKeyboardInput

Parameters:

callback - the callback to invoke

poll

public void poll()

Description copied from interface: RenderModuleKeyboardInput

Samples the keyboard, refreshing what the query methods report.

Called once per frame by the owning window.

Specified by:

poll in interface RenderModuleKeyboardInput

clean

public void clean()

Description copied from interface: RenderModuleKeyboardInput

Clears per-frame state, so that tapped keys are not reported twice.

Specified by:

clean in interface RenderModuleKeyboardInput

keyPressed

public boolean keyPressed(RenderModuleKeyboardInput.KeyCtx keyCtx)

Description copied from interface: RenderModuleKeyboardInput

Returns whether a key is currently held down.

Specified by:

keyPressed in interface RenderModuleKeyboardInput

Parameters:

keyCtx - the key to test

Returns:

true while the key is held

keyTapped

public boolean keyTapped(RenderModuleKeyboardInput.KeyCtx keyCtx)

Description copied from interface: RenderModuleKeyboardInput

Returns whether a key went down during the frame just sampled.

Unlike RenderModuleKeyboardInput.keyPressed(RenderModuleKeyboardInput.KeyCtx), this is true for a single frame per press.

Specified by:

keyTapped in interface RenderModuleKeyboardInput

Parameters:

keyCtx - the key to test

Returns:

true if the key was newly pressed this frame

invoke

public void invoke(long handle,
 int keyCode,
 int scanCode,
 int action,
 int mods)

Records a key change from GLFW and notifies the registered callbacks.

Events for other windows are ignored, since a GLFW callback is shared across the process.

Specified by:

invoke in interface org.lwjgl.glfw.GLFWKeyCallbackI

Parameters:

handle - the GLFW window the event came from

keyCode - the GLFW key code

scanCode - the platform-specific scancode

action - the GLFW action, such as GLFW_PRESS or GLFW_RELEASE

mods - the modifier key bitmask in effect