Start » Filter Reference » System » User Input » GetKeyboardKeyState

GetKeyboardKeyState


Module: FoundationLite

Checks if the specified keyboard key is down and if it is toggled.

Name Type Description
Input value
inKeyCode Integer Virtual key code. See documentation for a complete table.
Output value
outIsDown Bool Informs if the specified keyboard key is being pressed at the moment.
Output value
outIsToggled Bool Informs about the state. Important for keys such as CapsLock.

Examples

Description of usage of this filter can be found in examples and tutorial: Brick destroy (Game).

Remarks

For complete list of virtual key codes, please follow the link below:
https://docs.microsoft.com/windows/desktop/inputdev/virtual-key-codes

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • GetKeyboardKeys – Returns virtual key codes of the pressed keys or NULL if no key was pressed.