Top Description Fields Methods
org.lwjgl.glfw

public Interface GLFWKeyCallbackI

extends CallbackI
Known Direct Implementers
org.lwjgl.glfw.GLFWKeyCallback
Annotations
@FunctionalInterface
@NativeType:GLFWkeyfun
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Instances of this interface may be passed to the SetKeyCallback method.

Type


void (*invoke) (
    GLFWwindow *window,
    int key,
    int scancode,
    int action,
    int mods
)

Field Summary

Modifier and TypeField and Description
public static final FFICIF
CIF

Method Summary

Modifier and TypeMethod and Description
public default void
callback(long
a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

ret, long
a vector of pointers to memory holding the arguments to the function
args)

Implements org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.
public default FFICIF
getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function.
public void
invoke(long
the window that received the event
window, int
the keyboard key that was pressed or released
key, int
the platform-specific scancode of the key
scancode, int
the key action. One of:
PRESSRELEASEREPEAT
action, int
bitfield describing which modifiers keys were held down
mods)

Will be called when a key is pressed, repeated or released.

Inherited from org.lwjgl.system.CallbackI:
address

Field Detail

CIFback to summary
public static final FFICIF CIF

Method Detail

callbackback to summary
public default void callback(long ret, long args)

Implements org.lwjgl.system.CallbackI.callback.

Doc from org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.

Parameters
ret:long

a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

args:long

a vector of pointers to memory holding the arguments to the function

Annotations
@Override
getCallInterfaceback to summary
public default FFICIF getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Doc from org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function. [INTERNAL API]

Returns:FFICIF

the CIF structure for this callback function

Annotations
@Override
invokeback to summary
public void invoke(long window, int key, int scancode, int action, int mods)

Will be called when a key is pressed, repeated or released.

Parameters
window:long

the window that received the event

key:int

the keyboard key that was pressed or released

scancode:int

the platform-specific scancode of the key

action:int

the key action. One of:

PRESSRELEASEREPEAT
mods:int

bitfield describing which modifiers keys were held down