Loading...
Searching...
No Matches
Keyboard.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <SFML/Window/Export.hpp>
31
32
33namespace sf
34{
35class String;
36
41namespace Keyboard
42{
156
161// NOLINTNEXTLINE(readability-identifier-naming)
162static constexpr unsigned int KeyCount{static_cast<unsigned int>(Key::Pause) + 1};
163
172enum class Scan
173{
174 Unknown = -1,
175 A = 0,
176 B,
177 C,
178 D,
179 E,
180 F,
181 G,
182 H,
183 I,
184 J,
185 K,
186 L,
187 M,
188 N,
189 O,
190 P,
191 Q,
192 R,
193 S,
194 T,
195 U,
196 V,
197 W,
198 X,
199 Y,
200 Z,
201 Num1,
202 Num2,
203 Num3,
204 Num4,
205 Num5,
206 Num6,
207 Num7,
208 Num8,
209 Num9,
210 Num0,
211 Enter,
212 Escape,
213 Backspace,
214 Tab,
215 Space,
216 Hyphen,
217 Equal,
218 LBracket,
219 RBracket,
220 // For US keyboards mapped to key 29 (Microsoft Keyboard Scan Code Specification)
221 // For Non-US keyboards mapped to key 42 (Microsoft Keyboard Scan Code Specification)
222 // Typical language mappings: Belg:£µ` FrCa:<>} Dan:*' Dutch:`´ Fren:µ* Ger:'# Ital:§ù LatAm:[}` Nor:*@ Span:ç} Swed:*' Swiss:$£} UK:~# Brazil:}]
223 Backslash,
224 Semicolon,
225 Apostrophe,
226 Grave,
227 Comma,
228 Period,
229 Slash,
230 F1,
231 F2,
232 F3,
233 F4,
234 F5,
235 F6,
236 F7,
237 F8,
238 F9,
239 F10,
240 F11,
241 F12,
242 F13,
243 F14,
244 F15,
245 F16,
246 F17,
247 F18,
248 F19,
249 F20,
250 F21,
251 F22,
252 F23,
253 F24,
254 CapsLock,
255 PrintScreen,
256 ScrollLock,
257 Pause,
258 Insert,
259 Home,
260 PageUp,
261 Delete,
262 End,
263 PageDown,
264 Right,
265 Left,
266 Down,
267 Up,
268 NumLock,
269 NumpadDivide,
270 NumpadMultiply,
271 NumpadMinus,
272 NumpadPlus,
273 NumpadEqual,
274 NumpadEnter,
275 NumpadDecimal,
276 Numpad1,
277 Numpad2,
278 Numpad3,
279 Numpad4,
280 Numpad5,
281 Numpad6,
282 Numpad7,
283 Numpad8,
284 Numpad9,
285 Numpad0,
286 // For US keyboards doesn't exist
287 // For Non-US keyboards mapped to key 45 (Microsoft Keyboard Scan Code Specification)
288 // Typical language mappings: Belg:<> FrCa:«°» Dan:<> Dutch:]|[ Fren:<> Ger:<|> Ital:<> LatAm:<> Nor:<> Span:<> Swed:<|> Swiss:<> UK:\| Brazil: \|.
289 NonUsBackslash,
290 Application,
291 Execute,
292 ModeChange,
293 Help,
294 Menu,
295 Select,
296 Redo,
297 Undo,
298 Cut,
299 Copy,
300 Paste,
301 VolumeMute,
302 VolumeUp,
303 VolumeDown,
304 MediaPlayPause,
305 MediaStop,
306 MediaNextTrack,
307 MediaPreviousTrack,
308 LControl,
309 LShift,
310 LAlt,
311 LSystem,
312 RControl,
313 RShift,
314 RAlt,
315 RSystem,
316 Back,
317 Forward,
318 Refresh,
319 Stop,
320 Search,
321 Favorites,
322 HomePage,
323 LaunchApplication1,
324 LaunchApplication2,
325 LaunchMail,
326 LaunchMediaSelect,
327};
328
329using Scancode = Scan;
330
335// NOLINTNEXTLINE(readability-identifier-naming)
336static constexpr unsigned int ScancodeCount{static_cast<unsigned int>(Scan::LaunchMediaSelect) + 1};
337
349[[nodiscard]] SFML_WINDOW_API bool isKeyPressed(Key key);
350
362[[nodiscard]] SFML_WINDOW_API bool isKeyPressed(Scancode code);
363
377[[nodiscard]] SFML_WINDOW_API Key localize(Scancode code);
378
392[[nodiscard]] SFML_WINDOW_API Scancode delocalize(Key key);
393
415[[nodiscard]] SFML_WINDOW_API String getDescription(Scancode code);
416
430SFML_WINDOW_API void setVirtualKeyboardVisible(bool visible);
431} // namespace Keyboard
432
433} // namespace sf
434
435
SFML_WINDOW_API
#define SFML_WINDOW_API
Definition Window/Export.hpp:42
sf::String
Utility string class that automatically handles conversions between types and encodings.
Definition String.hpp:89
sf::Keyboard
Give access to the real-time state of the keyboard.
Definition Keyboard.hpp:42
sf::Keyboard::localize
Key localize(Scancode code)
Localize a physical key to a logical one.
sf::Keyboard::KeyCount
static constexpr unsigned int KeyCount
The total number of keyboard keys, ignoring Key::Unknown
Definition Keyboard.hpp:162
sf::Keyboard::ScancodeCount
static constexpr unsigned int ScancodeCount
The total number of scancodes, ignoring Scan::Unknown
Definition Keyboard.hpp:336
sf::Keyboard::delocalize
Scancode delocalize(Key key)
Identify the physical key corresponding to a logical one.
sf::Keyboard::getDescription
String getDescription(Scancode code)
Provide a string representation for a given scancode.
sf::Keyboard::setVirtualKeyboardVisible
void setVirtualKeyboardVisible(bool visible)
Show or hide the virtual keyboard.
sf::Keyboard::Key
Key
Key codes.
Definition Keyboard.hpp:52
sf::Keyboard::Key::Escape
@ Escape
The Escape key.
Definition Keyboard.hpp:90
sf::Keyboard::Key::X
@ X
The X key.
Definition Keyboard.hpp:77
sf::Keyboard::Key::Num6
@ Num6
The 6 key.
Definition Keyboard.hpp:86
sf::Keyboard::Key::RAlt
@ RAlt
The right Alt key.
Definition Keyboard.hpp:97
sf::Keyboard::Key::Down
@ Down
Down arrow.
Definition Keyboard.hpp:128
sf::Keyboard::Key::Divide
@ Divide
The / key.
Definition Keyboard.hpp:124
sf::Keyboard::Key::C
@ C
The C key.
Definition Keyboard.hpp:56
sf::Keyboard::Key::Pause
@ Pause
The Pause key.
Definition Keyboard.hpp:154
sf::Keyboard::Key::Numpad9
@ Numpad9
The numpad 9 key.
Definition Keyboard.hpp:138
sf::Keyboard::Key::LBracket
@ LBracket
The [ key.
Definition Keyboard.hpp:100
sf::Keyboard::Key::Period
@ Period
The . key.
Definition Keyboard.hpp:104
sf::Keyboard::Key::Numpad0
@ Numpad0
The numpad 0 key.
Definition Keyboard.hpp:129
sf::Keyboard::Key::Subtract
@ Subtract
The - key (minus, usually from numpad)
Definition Keyboard.hpp:122
sf::Keyboard::Key::F6
@ F6
The F6 key.
Definition Keyboard.hpp:144
sf::Keyboard::Key::Z
@ Z
The Z key.
Definition Keyboard.hpp:79
sf::Keyboard::Key::F14
@ F14
The F14 key.
Definition Keyboard.hpp:152
sf::Keyboard::Key::RSystem
@ RSystem
The right OS specific key: window (Windows and Linux), apple (macOS), ...
Definition Keyboard.hpp:98
sf::Keyboard::Key::Slash
@ Slash
The / key.
Definition Keyboard.hpp:106
sf::Keyboard::Key::F5
@ F5
The F5 key.
Definition Keyboard.hpp:143
sf::Keyboard::Key::E
@ E
The E key.
Definition Keyboard.hpp:58
sf::Keyboard::Key::Numpad7
@ Numpad7
The numpad 7 key.
Definition Keyboard.hpp:136
sf::Keyboard::Key::P
@ P
The P key.
Definition Keyboard.hpp:69
sf::Keyboard::Key::F7
@ F7
The F7 key.
Definition Keyboard.hpp:145
sf::Keyboard::Key::F8
@ F8
The F8 key.
Definition Keyboard.hpp:146
sf::Keyboard::Key::Num7
@ Num7
The 7 key.
Definition Keyboard.hpp:87
sf::Keyboard::Key::F3
@ F3
The F3 key.
Definition Keyboard.hpp:141
sf::Keyboard::Key::U
@ U
The U key.
Definition Keyboard.hpp:74
sf::Keyboard::Key::Numpad6
@ Numpad6
The numpad 6 key.
Definition Keyboard.hpp:135
sf::Keyboard::Key::Numpad4
@ Numpad4
The numpad 4 key.
Definition Keyboard.hpp:133
sf::Keyboard::Key::V
@ V
The V key.
Definition Keyboard.hpp:75
sf::Keyboard::Key::Y
@ Y
The Y key.
Definition Keyboard.hpp:78
sf::Keyboard::Key::Comma
@ Comma
The , key.
Definition Keyboard.hpp:103
sf::Keyboard::Key::Tab
@ Tab
The Tabulation key.
Definition Keyboard.hpp:114
sf::Keyboard::Key::S
@ S
The S key.
Definition Keyboard.hpp:72
sf::Keyboard::Key::Numpad3
@ Numpad3
The numpad 3 key.
Definition Keyboard.hpp:132
sf::Keyboard::Key::W
@ W
The W key.
Definition Keyboard.hpp:76
sf::Keyboard::Key::Numpad5
@ Numpad5
The numpad 5 key.
Definition Keyboard.hpp:134
sf::Keyboard::Key::F11
@ F11
The F11 key.
Definition Keyboard.hpp:149
sf::Keyboard::Key::LShift
@ LShift
The left Shift key.
Definition Keyboard.hpp:92
sf::Keyboard::Key::M
@ M
The M key.
Definition Keyboard.hpp:66
sf::Keyboard::Key::Hyphen
@ Hyphen
The - key (hyphen)
Definition Keyboard.hpp:110
sf::Keyboard::Key::Num2
@ Num2
The 2 key.
Definition Keyboard.hpp:82
sf::Keyboard::Key::Num5
@ Num5
The 5 key.
Definition Keyboard.hpp:85
sf::Keyboard::Key::A
@ A
The A key.
Definition Keyboard.hpp:54
sf::Keyboard::Key::F
@ F
The F key.
Definition Keyboard.hpp:59
sf::Keyboard::Key::Num0
@ Num0
The 0 key.
Definition Keyboard.hpp:80
sf::Keyboard::Key::End
@ End
The End key.
Definition Keyboard.hpp:117
sf::Keyboard::Key::Unknown
@ Unknown
Unhandled key.
Definition Keyboard.hpp:53
sf::Keyboard::Key::F9
@ F9
The F9 key.
Definition Keyboard.hpp:147
sf::Keyboard::Key::Num8
@ Num8
The 8 key.
Definition Keyboard.hpp:88
sf::Keyboard::Key::Numpad8
@ Numpad8
The numpad 8 key.
Definition Keyboard.hpp:137
sf::Keyboard::Key::Home
@ Home
The Home key.
Definition Keyboard.hpp:118
sf::Keyboard::Key::N
@ N
The N key.
Definition Keyboard.hpp:67
sf::Keyboard::Key::RShift
@ RShift
The right Shift key.
Definition Keyboard.hpp:96
sf::Keyboard::Key::Right
@ Right
Right arrow.
Definition Keyboard.hpp:126
sf::Keyboard::Key::Left
@ Left
Left arrow.
Definition Keyboard.hpp:125
sf::Keyboard::Key::F13
@ F13
The F13 key.
Definition Keyboard.hpp:151
sf::Keyboard::Key::Semicolon
@ Semicolon
The ; key.
Definition Keyboard.hpp:102
sf::Keyboard::Key::PageUp
@ PageUp
The Page up key.
Definition Keyboard.hpp:115
sf::Keyboard::Key::B
@ B
The B key.
Definition Keyboard.hpp:55
sf::Keyboard::Key::LControl
@ LControl
The left Control key.
Definition Keyboard.hpp:91
sf::Keyboard::Key::Num3
@ Num3
The 3 key.
Definition Keyboard.hpp:83
sf::Keyboard::Key::Insert
@ Insert
The Insert key.
Definition Keyboard.hpp:119
sf::Keyboard::Key::K
@ K
The K key.
Definition Keyboard.hpp:64
sf::Keyboard::Key::LAlt
@ LAlt
The left Alt key.
Definition Keyboard.hpp:93
sf::Keyboard::Key::RControl
@ RControl
The right Control key.
Definition Keyboard.hpp:95
sf::Keyboard::Key::F10
@ F10
The F10 key.
Definition Keyboard.hpp:148
sf::Keyboard::Key::Menu
@ Menu
The Menu key.
Definition Keyboard.hpp:99
sf::Keyboard::Key::Apostrophe
@ Apostrophe
The ' key.
Definition Keyboard.hpp:105
sf::Keyboard::Key::T
@ T
The T key.
Definition Keyboard.hpp:73
sf::Keyboard::Key::Num1
@ Num1
The 1 key.
Definition Keyboard.hpp:81
sf::Keyboard::Key::H
@ H
The H key.
Definition Keyboard.hpp:61
sf::Keyboard::Key::RBracket
@ RBracket
The ] key.
Definition Keyboard.hpp:101
sf::Keyboard::Key::Numpad1
@ Numpad1
The numpad 1 key.
Definition Keyboard.hpp:130
sf::Keyboard::Key::Backspace
@ Backspace
The Backspace key.
Definition Keyboard.hpp:113
sf::Keyboard::Key::L
@ L
The L key.
Definition Keyboard.hpp:65
sf::Keyboard::Key::Space
@ Space
The Space key.
Definition Keyboard.hpp:111
sf::Keyboard::Key::Num9
@ Num9
The 9 key.
Definition Keyboard.hpp:89
sf::Keyboard::Key::I
@ I
The I key.
Definition Keyboard.hpp:62
sf::Keyboard::Key::G
@ G
The G key.
Definition Keyboard.hpp:60
sf::Keyboard::Key::Num4
@ Num4
The 4 key.
Definition Keyboard.hpp:84
sf::Keyboard::Key::F1
@ F1
The F1 key.
Definition Keyboard.hpp:139
sf::Keyboard::Key::R
@ R
The R key.
Definition Keyboard.hpp:71
sf::Keyboard::Key::Multiply
@ Multiply
The * key.
Definition Keyboard.hpp:123
sf::Keyboard::Key::F15
@ F15
The F15 key.
Definition Keyboard.hpp:153
sf::Keyboard::Key::F4
@ F4
The F4 key.
Definition Keyboard.hpp:142
sf::Keyboard::Key::F12
@ F12
The F12 key.
Definition Keyboard.hpp:150
sf::Keyboard::Key::Add
@ Add
The + key.
Definition Keyboard.hpp:121
sf::Keyboard::Key::Grave
@ Grave
The ` key.
Definition Keyboard.hpp:108
sf::Keyboard::Key::PageDown
@ PageDown
The Page down key.
Definition Keyboard.hpp:116
sf::Keyboard::Key::Q
@ Q
The Q key.
Definition Keyboard.hpp:70
sf::Keyboard::Key::Enter
@ Enter
The Enter/Return keys.
Definition Keyboard.hpp:112
sf::Keyboard::Key::O
@ O
The O key.
Definition Keyboard.hpp:68
sf::Keyboard::Key::Delete
@ Delete
The Delete key.
Definition Keyboard.hpp:120
sf::Keyboard::Key::Equal
@ Equal
The = key.
Definition Keyboard.hpp:109
sf::Keyboard::Key::D
@ D
The D key.
Definition Keyboard.hpp:57
sf::Keyboard::Key::Backslash
@ Backslash
The \ key.
Definition Keyboard.hpp:107
sf::Keyboard::Key::Numpad2
@ Numpad2
The numpad 2 key.
Definition Keyboard.hpp:131
sf::Keyboard::Key::LSystem
@ LSystem
The left OS specific key: window (Windows and Linux), apple (macOS), ...
Definition Keyboard.hpp:94
sf::Keyboard::Key::F2
@ F2
The F2 key.
Definition Keyboard.hpp:140
sf::Keyboard::Key::J
@ J
The J key.
Definition Keyboard.hpp:63
sf::Keyboard::isKeyPressed
bool isKeyPressed(Key key)
Check if a key is pressed.
sf::Keyboard::Scan
Scan
Scancodes.
Definition Keyboard.hpp:173
sf::Keyboard::Scan::LaunchMediaSelect
@ LaunchMediaSelect
Keyboard Launch Media Select key.
Definition Keyboard.hpp:326
sf::Keyboard::Scan::Back
@ Back
Keyboard Back key.
Definition Keyboard.hpp:316
sf::Keyboard::Scan::Stop
@ Stop
Keyboard Stop key.
Definition Keyboard.hpp:319
sf::Keyboard::Scan::Search
@ Search
Keyboard Search key.
Definition Keyboard.hpp:320
sf::Keyboard::Scan::Undo
@ Undo
Keyboard Undo key.
Definition Keyboard.hpp:297
sf::Keyboard::Scan::MediaPreviousTrack
@ MediaPreviousTrack
Keyboard Media Previous Track key.
Definition Keyboard.hpp:307
sf::Keyboard::Scan::LaunchMail
@ LaunchMail
Keyboard Launch Mail key.
Definition Keyboard.hpp:325
sf::Keyboard::Scan::Paste
@ Paste
Keyboard Paste key.
Definition Keyboard.hpp:300
sf::Keyboard::Scan::NumpadMultiply
@ NumpadMultiply
Keypad * key.
Definition Keyboard.hpp:270
sf::Keyboard::Scan::Execute
@ Execute
Keyboard Execute key.
Definition Keyboard.hpp:291
sf::Keyboard::Scan::NumpadEnter
@ NumpadEnter
Keypad Enter/Return key.
Definition Keyboard.hpp:274
sf::Keyboard::Scan::MediaStop
@ MediaStop
Keyboard Media Stop key.
Definition Keyboard.hpp:305
sf::Keyboard::Scan::MediaNextTrack
@ MediaNextTrack
Keyboard Media Next Track key.
Definition Keyboard.hpp:306
sf::Keyboard::Scan::F16
@ F16
Keyboard F16 key.
Definition Keyboard.hpp:245
sf::Keyboard::Scan::Redo
@ Redo
Keyboard Redo key.
Definition Keyboard.hpp:296
sf::Keyboard::Scan::Copy
@ Copy
Keyboard Copy key.
Definition Keyboard.hpp:299
sf::Keyboard::Scan::Refresh
@ Refresh
Keyboard Refresh key.
Definition Keyboard.hpp:318
sf::Keyboard::Scan::Forward
@ Forward
Keyboard Forward key.
Definition Keyboard.hpp:317
sf::Keyboard::Scan::Help
@ Help
Keyboard Help key.
Definition Keyboard.hpp:293
sf::Keyboard::Scan::LaunchApplication2
@ LaunchApplication2
Keyboard Launch Application 2 key.
Definition Keyboard.hpp:324
sf::Keyboard::Scan::F21
@ F21
Keyboard F21 key.
Definition Keyboard.hpp:250
sf::Keyboard::Scan::ScrollLock
@ ScrollLock
Keyboard Scroll Lock key.
Definition Keyboard.hpp:256
sf::Keyboard::Scan::F22
@ F22
Keyboard F22 key.
Definition Keyboard.hpp:251
sf::Keyboard::Scan::F18
@ F18
Keyboard F18 key.
Definition Keyboard.hpp:247
sf::Keyboard::Scan::F23
@ F23
Keyboard F23 key.
Definition Keyboard.hpp:252
sf::Keyboard::Scan::NumpadEqual
@ NumpadEqual
keypad = key
Definition Keyboard.hpp:273
sf::Keyboard::Scan::CapsLock
@ CapsLock
Keyboard Caps Lock key.
Definition Keyboard.hpp:254
sf::Keyboard::Scan::VolumeDown
@ VolumeDown
Keyboard Volume Down key.
Definition Keyboard.hpp:303
sf::Keyboard::Scan::VolumeMute
@ VolumeMute
Keyboard Volume Mute key.
Definition Keyboard.hpp:301
sf::Keyboard::Scan::NumpadDecimal
@ NumpadDecimal
Keypad . and Delete key.
Definition Keyboard.hpp:275
sf::Keyboard::Scan::NumpadPlus
@ NumpadPlus
Keypad + key.
Definition Keyboard.hpp:272
sf::Keyboard::Scan::MediaPlayPause
@ MediaPlayPause
Keyboard Media Play Pause key.
Definition Keyboard.hpp:304
sf::Keyboard::Scan::NumpadDivide
@ NumpadDivide
Keypad / key.
Definition Keyboard.hpp:269
sf::Keyboard::Scan::PrintScreen
@ PrintScreen
Keyboard Print Screen key.
Definition Keyboard.hpp:255
sf::Keyboard::Scan::HomePage
@ HomePage
Keyboard Home Page key.
Definition Keyboard.hpp:322
sf::Keyboard::Scan::NonUsBackslash
@ NonUsBackslash
Keyboard Non-US \ and | key.
Definition Keyboard.hpp:289
sf::Keyboard::Scan::F19
@ F19
Keyboard F19 key.
Definition Keyboard.hpp:248
sf::Keyboard::Scan::NumLock
@ NumLock
Keypad Num Lock and Clear key.
Definition Keyboard.hpp:268
sf::Keyboard::Scan::LaunchApplication1
@ LaunchApplication1
Keyboard Launch Application 1 key.
Definition Keyboard.hpp:323
sf::Keyboard::Scan::Favorites
@ Favorites
Keyboard Favorites key.
Definition Keyboard.hpp:321
sf::Keyboard::Scan::Select
@ Select
Keyboard Select key.
Definition Keyboard.hpp:295
sf::Keyboard::Scan::Application
@ Application
Keyboard Application key.
Definition Keyboard.hpp:290
sf::Keyboard::Scan::ModeChange
@ ModeChange
Keyboard Mode Change key.
Definition Keyboard.hpp:292
sf::Keyboard::Scan::Cut
@ Cut
Keyboard Cut key.
Definition Keyboard.hpp:298
sf::Keyboard::Scan::F24
@ F24
Keyboard F24 key.
Definition Keyboard.hpp:253
sf::Keyboard::Scan::VolumeUp
@ VolumeUp
Keyboard Volume Up key.
Definition Keyboard.hpp:302
sf::Keyboard::Scan::NumpadMinus
@ NumpadMinus
Keypad - key.
Definition Keyboard.hpp:271
sf::Keyboard::Scan::F20
@ F20
Keyboard F20 key.
Definition Keyboard.hpp:249
sf::Keyboard::Scan::F17
@ F17
Keyboard F17 key.
Definition Keyboard.hpp:246