KeySignal
extends Signal
in package
Table of Contents
Properties
- $action : int
- The key action. One of: GLFW_PRESS, GLFW_RELEASE or GLFW_REPEAT
- $key : int
- The key that was pressed, repeated or released
- $mods : int
- Bit field describing which modifier keys were held down
- $scancode : int
- The system-specific scancode of the key
- $window : Window
- The window that received the event
Methods
- __construct() : mixed
- Constructor
- __debugInfo() : array<string, mixed>
- Omits the window property from the debug output
- isAltDown() : bool
- isCapsLockOn() : bool
- isControlDown() : bool
- isNumLockOn() : bool
- isPropagationStopped() : bool
- Has the propagation been stopped?
- isShiftDown() : bool
- isSuperDown() : bool
- stopPropagation() : void
- Stop the propagation of the signal
Properties
$action read-only
The key action. One of: GLFW_PRESS, GLFW_RELEASE or GLFW_REPEAT
public
int
$action
$key read-only
The key that was pressed, repeated or released
public
int
$key
$mods read-only
Bit field describing which modifier keys were held down
public
int
$mods
$scancode read-only
The system-specific scancode of the key
public
int
$scancode
$window read-only
The window that received the event
public
Window
$window
Methods
__construct()
Constructor
public
__construct(Window $window, int $key, int $scancode, int $action, int $mods) : mixed
Parameters
- $window : Window
-
The window that received the event
- $key : int
-
The key that was pressed, repeated or released
- $scancode : int
-
The system-specific scancode of the key
- $action : int
-
The key action. One of: GLFW_PRESS, GLFW_RELEASE or GLFW_REPEAT
- $mods : int
-
Bit field describing which modifier keys were held down
__debugInfo()
Omits the window property from the debug output
public
__debugInfo() : array<string, mixed>
Return values
array<string, mixed>isAltDown()
public
isAltDown() : bool
Return values
boolisCapsLockOn()
public
isCapsLockOn() : bool
Return values
boolisControlDown()
public
isControlDown() : bool
Return values
boolisNumLockOn()
public
isNumLockOn() : bool
Return values
boolisPropagationStopped()
Has the propagation been stopped?
public
isPropagationStopped() : bool
Return values
boolisShiftDown()
public
isShiftDown() : bool
Return values
boolisSuperDown()
public
isSuperDown() : bool
Return values
boolstopPropagation()
Stop the propagation of the signal
public
stopPropagation() : void