CSFML - C binding of the Simple and Fast Multimedia Library

CSFML
Enumerations | Functions
Keyboard.h File Reference
`#include <SFML/Window/Export.h>`

Go to the source code of this file.

## Enumerations
enum | sfKeyCode { sfKeyUnknown = -1, sfKeyA, sfKeyB, sfKeyC, sfKeyD, sfKeyE, sfKeyF, sfKeyG, sfKeyH, sfKeyI, sfKeyJ, sfKeyK, sfKeyL, sfKeyM, sfKeyN, sfKeyO, sfKeyP, sfKeyQ, sfKeyR, sfKeyS, sfKeyT, sfKeyU, sfKeyV, sfKeyW, sfKeyX, sfKeyY, sfKeyZ, sfKeyNum0, sfKeyNum1, sfKeyNum2, sfKeyNum3, sfKeyNum4, sfKeyNum5, sfKeyNum6, sfKeyNum7, sfKeyNum8, sfKeyNum9, sfKeyEscape, sfKeyLControl, sfKeyLShift, sfKeyLAlt, sfKeyLSystem, sfKeyRControl, sfKeyRShift, sfKeyRAlt, sfKeyRSystem, sfKeyMenu, sfKeyLBracket, sfKeyRBracket, sfKeySemiColon, sfKeyComma, sfKeyPeriod, sfKeyQuote, sfKeySlash, sfKeyBackSlash, sfKeyTilde, sfKeyEqual, sfKeyDash, sfKeySpace, sfKeyReturn, sfKeyBack, sfKeyTab, sfKeyPageUp, sfKeyPageDown, sfKeyEnd, sfKeyHome, sfKeyInsert, sfKeyDelete, sfKeyAdd, sfKeySubtract, sfKeyMultiply, sfKeyDivide, sfKeyLeft, sfKeyRight, sfKeyUp, sfKeyDown, sfKeyNumpad0, sfKeyNumpad1, sfKeyNumpad2, sfKeyNumpad3, sfKeyNumpad4, sfKeyNumpad5, sfKeyNumpad6, sfKeyNumpad7, sfKeyNumpad8, sfKeyNumpad9, sfKeyF1, sfKeyF2, sfKeyF3, sfKeyF4, sfKeyF5, sfKeyF6, sfKeyF7, sfKeyF8, sfKeyF9, sfKeyF10, sfKeyF11, sfKeyF12, sfKeyF13, sfKeyF14, sfKeyF15, sfKeyPause, sfKeyCount }
| Key codes. More...

## Functions
CSFML_WINDOW_API sfBool | sfKeyboard_isKeyPressed (sfKeyCode key)
| Check if a key is pressed. More...
CSFML_WINDOW_API void | sfKeyboard_setVirtualKeyboardVisible (sfBool visible)
| Show or hide the virtual keyboard. More...

## Enumeration Type Documentation

## ◆ sfKeyCode

enum sfKeyCode

Key codes.

Enumerator
sfKeyUnknown | Unhandled key.
sfKeyA | The A key.
sfKeyB | The B key.
sfKeyC | The C key.
sfKeyD | The D key.
sfKeyE | The E key.
sfKeyF | The F key.
sfKeyG | The G key.
sfKeyH | The H key.
sfKeyI | The I key.
sfKeyJ | The J key.
sfKeyK | The K key.
sfKeyL | The L key.
sfKeyM | The M key.
sfKeyN | The N key.
sfKeyO | The O key.
sfKeyP | The P key.
sfKeyQ | The Q key.
sfKeyR | The R key.
sfKeyS | The S key.
sfKeyT | The T key.
sfKeyU | The U key.
sfKeyV | The V key.
sfKeyW | The W key.
sfKeyX | The X key.
sfKeyY | The Y key.
sfKeyZ | The Z key.
sfKeyNum0 | The 0 key.
sfKeyNum1 | The 1 key.
sfKeyNum2 | The 2 key.
sfKeyNum3 | The 3 key.
sfKeyNum4 | The 4 key.
sfKeyNum5 | The 5 key.
sfKeyNum6 | The 6 key.
sfKeyNum7 | The 7 key.
sfKeyNum8 | The 8 key.
sfKeyNum9 | The 9 key.
sfKeyEscape | The Escape key.
sfKeyLControl | The left Control key.
sfKeyLShift | The left Shift key.
sfKeyLAlt | The left Alt key.
sfKeyLSystem | The left OS specific key: window (Windows and Linux), apple (MacOS X), ...
sfKeyRControl | The right Control key.
sfKeyRShift | The right Shift key.
sfKeyRAlt | The right Alt key.
sfKeyRSystem | The right OS specific key: window (Windows and Linux), apple (MacOS X), ...
sfKeyMenu | The Menu key.
sfKeyLBracket | The [ key.
sfKeyRBracket | The ] key.
sfKeySemiColon | The ; key.
sfKeyComma | The , key.
sfKeyPeriod | The . key.
sfKeyQuote | The ' key.
sfKeySlash | The / key.
sfKeyBackSlash | The \ key.
sfKeyTilde | The ~ key.
sfKeyEqual | The = key.
sfKeyDash | The - key.
sfKeySpace | The Space key.
sfKeyReturn | The Return key.
sfKeyBack | The Backspace key.
sfKeyTab | The Tabulation key.
sfKeyPageUp | The Page up key.
sfKeyPageDown | The Page down key.
sfKeyEnd | The End key.
sfKeyHome | The Home key.
sfKeyInsert | The Insert key.
sfKeyDelete | The Delete key.
sfKeyAdd |
sfKeySubtract |
sfKeyMultiply |
sfKeyDivide | /
sfKeyLeft | Left arrow.
sfKeyRight | Right arrow.
sfKeyUp | Up arrow.
sfKeyDown | Down arrow.
sfKeyNumpad0 | The numpad 0 key.
sfKeyNumpad1 | The numpad 1 key.
sfKeyNumpad2 | The numpad 2 key.
sfKeyNumpad3 | The numpad 3 key.
sfKeyNumpad4 | The numpad 4 key.
sfKeyNumpad5 | The numpad 5 key.
sfKeyNumpad6 | The numpad 6 key.
sfKeyNumpad7 | The numpad 7 key.
sfKeyNumpad8 | The numpad 8 key.
sfKeyNumpad9 | The numpad 9 key.
sfKeyF1 | The F1 key.
sfKeyF2 | The F2 key.
sfKeyF3 | The F3 key.
sfKeyF4 | The F4 key.
sfKeyF5 | The F5 key.
sfKeyF6 | The F6 key.
sfKeyF7 | The F7 key.
sfKeyF8 | The F8 key.
sfKeyF9 | The F8 key.
sfKeyF10 | The F10 key.
sfKeyF11 | The F11 key.
sfKeyF12 | The F12 key.
sfKeyF13 | The F13 key.
sfKeyF14 | The F14 key.
sfKeyF15 | The F15 key.
sfKeyPause | The Pause key.
sfKeyCount | Keep last – the total number of keyboard keys.

Definition at line 38 of file Keyboard.h.

## Function Documentation

## ◆ sfKeyboard_isKeyPressed()

CSFML_WINDOW_API sfBool sfKeyboard_isKeyPressed | ( | sfKeyCode | key | ) |

Check if a key is pressed.

Parameters

  key | Key to check

Returns
  sfTrue if the key is pressed, sfFalse otherwise

## ◆ sfKeyboard_setVirtualKeyboardVisible()

CSFML_WINDOW_API void sfKeyboard_setVirtualKeyboardVisible | ( | sfBool | visible | ) |

Show or hide the virtual keyboard.

Warning: the virtual keyboard is not supported on all systems. It will typically be implemented on mobile OSes (Android, iOS) but not on desktop OSes (Windows, Linux, ...).

If the virtual keyboard is not available, this function does nothing.

Parameters

  visible | True to show, false to hide