SDL3pp
A slim C++ wrapper for SDL3
All Classes Namespaces Functions Variables Typedefs Modules Pages Concepts
SDL3pp_keyboard.h
1#ifndef SDL3PP_KEYBOARD_H_
2#define SDL3PP_KEYBOARD_H_
3
4#include <SDL3/SDL_keyboard.h>
5#include "SDL3pp_keycode.h"
6#include "SDL3pp_scancode.h"
7#include "SDL3pp_stdinc.h"
8#include "SDL3pp_video.h"
9
10namespace SDL {
11
36using KeyboardID = SDL_KeyboardID;
37
49inline bool HasKeyboard() { return SDL_HasKeyboard(); }
50
72inline KeyboardID* GetKeyboards(int* count) { return SDL_GetKeyboards(count); }
73
89inline const char* GetKeyboardNameForID(KeyboardID instance_id)
90{
91 return SDL_GetKeyboardNameForID(instance_id);
92}
93
103inline WindowRef GetKeyboardFocus() { return SDL_GetKeyboardFocus(); }
104
136inline const bool* GetKeyboardState(int* numkeys = nullptr)
137{
138 return SDL_GetKeyboardState(numkeys);
139}
140
152inline void ResetKeyboard() { SDL_ResetKeyboard(); }
153
167inline Keymod GetModState() { return SDL_GetModState(); }
168
188inline void SetModState(Keymod modstate) { SDL_SetModState(modstate); }
189
212inline Keycode::Keycode(Scancode scancode, Keymod modstate, bool key_event)
213 : Keycode(SDL_GetKeyFromScancode(scancode, modstate, key_event))
214{
215}
216
233 : Keycode(SDL_GetKeyFromName(name))
234{
235}
236
255inline Scancode Keycode::GetScancode(Keymod* modstate) const
256{
257 return SDL_GetScancodeFromKey(m_keycode, modstate);
258}
259
275{
276 CheckError(SDL_SetScancodeName(m_scancode, name));
277}
278
302inline const char* Scancode::GetName() const
303{
304 return SDL_GetScancodeName(m_scancode);
305}
306
323 : Scancode(SDL_GetScancodeFromName(name))
324{
325}
326
344inline const char* Keycode::GetName() const
345{
346 return SDL_GetKeyName(m_keycode);
347}
348
374{
375 return CheckError(SDL_StartTextInput(get()));
376}
377
427{
428 CheckError(SDL_StartTextInputWithProperties(get(), props.get()));
429}
430
442using TextInputType = SDL_TextInputType;
443
445 SDL_TEXTINPUT_TYPE_TEXT;
446
448 SDL_TEXTINPUT_TYPE_TEXT_NAME;
449
451 SDL_TEXTINPUT_TYPE_TEXT_EMAIL;
452
454 SDL_TEXTINPUT_TYPE_TEXT_USERNAME;
455
457 SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN;
459
461 SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE;
463
465 SDL_TEXTINPUT_TYPE_NUMBER;
466
468 SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN;
470
472 SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE;
474
486using Capitalization = SDL_Capitalization;
487
489 SDL_CAPITALIZE_NONE;
490
492 SDL_CAPITALIZE_SENTENCES;
494
496 SDL_CAPITALIZE_WORDS;
497
499 SDL_CAPITALIZE_LETTERS;
500
501namespace prop::TextInput {
502
503constexpr auto TYPE_NUMBER = SDL_PROP_TEXTINPUT_TYPE_NUMBER;
504
505constexpr auto CAPITALIZATION_NUMBER = SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER;
506
507constexpr auto AUTOCORRECT_BOOLEAN = SDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN;
508
509constexpr auto MULTILINE_BOOLEAN = SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN;
510
511constexpr auto ANDROID_INPUTTYPE_NUMBER =
512 SDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER;
513
514} // namespace prop::TextInput
515
528{
529 return SDL_TextInputActive(get());
530}
531
547{
548 CheckError(SDL_StopTextInput(get()));
549}
550
564{
565 CheckError(SDL_ClearComposition(get()));
566}
567
587inline void WindowBase::SetTextInputArea(const SDL_Rect& rect, int cursor)
588{
589 CheckError(SDL_SetTextInputArea(get(), &rect, cursor));
590}
591
609inline void WindowBase::GetTextInputArea(Rect* rect, int* cursor)
610{
611 CheckError(SDL_GetTextInputArea(get(), rect, cursor));
612}
613
628{
629 return SDL_HasScreenKeyboardSupport();
630}
631
644{
645 return SDL_ScreenKeyboardShown(get());
646}
647
649} // namespace SDL
650
651#endif /* SDL3PP_KEYBOARD_H_ */
The SDL virtual key representation.
Definition SDL3pp_keycode.h:157
constexpr Keycode(SDL_Keycode keycode={})
Wraps Keycode.
Definition SDL3pp_keycode.h:166
constexpr SDL_Window * get() const
Return contained resource;.
Definition SDL3pp_resource.h:57
The SDL keyboard scancode representation.
Definition SDL3pp_scancode.h:41
constexpr Scancode(SDL_Scancode scancode={})
Wraps Scancode.
Definition SDL3pp_scancode.h:50
Helpers to use C++ strings parameters.
Definition SDL3pp_strings.h:43
constexpr void CheckError(bool result)
Check and throw if returned value from SDL is an error.
Definition SDL3pp_error.h:206
constexpr TextInputType TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN
The input is a secure PIN that is hidden.
Definition SDL3pp_keyboard.h:467
void GetTextInputArea(Rect *rect, int *cursor)
Get the area used to type Unicode text input.
Definition SDL3pp_keyboard.h:609
void SetName(StringParam name)
Set a human-readable name for a scancode.
Definition SDL3pp_keyboard.h:274
const char * GetName() const
Get a human-readable name for a key.
Definition SDL3pp_keyboard.h:344
SDL_KeyboardID KeyboardID
This is a unique ID for a keyboard for the time it is connected to the system, and is never reused fo...
Definition SDL3pp_keyboard.h:36
const bool * GetKeyboardState(int *numkeys=nullptr)
Get a snapshot of the current state of the keyboard.
Definition SDL3pp_keyboard.h:136
void ResetKeyboard()
Clear the state of the keyboard.
Definition SDL3pp_keyboard.h:152
void StopTextInput()
Stop receiving any text input events in a window.
Definition SDL3pp_keyboard.h:546
KeyboardID * GetKeyboards(int *count)
Get a list of currently connected keyboards.
Definition SDL3pp_keyboard.h:72
bool HasKeyboard()
Return whether a keyboard is currently connected.
Definition SDL3pp_keyboard.h:49
void SetModState(Keymod modstate)
Set the current key modifier state for the keyboard.
Definition SDL3pp_keyboard.h:188
constexpr TextInputType TEXTINPUT_TYPE_TEXT_NAME
The input is a person's name.
Definition SDL3pp_keyboard.h:447
Keymod GetModState()
Get the current key modifier state for the keyboard.
Definition SDL3pp_keyboard.h:167
bool IsScreenKeyboardShown() const
Check whether the screen keyboard is shown for given window.
Definition SDL3pp_keyboard.h:643
const char * GetKeyboardNameForID(KeyboardID instance_id)
Get the name of a keyboard.
Definition SDL3pp_keyboard.h:89
WindowRef GetKeyboardFocus()
Query the window which currently has keyboard focus.
Definition SDL3pp_keyboard.h:103
constexpr TextInputType TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN
The input is a secure password that is hidden.
Definition SDL3pp_keyboard.h:456
constexpr TextInputType TEXTINPUT_TYPE_TEXT_EMAIL
The input is an e-mail address.
Definition SDL3pp_keyboard.h:450
constexpr Capitalization CAPITALIZE_SENTENCES
The first letter of sentences will be capitalized.
Definition SDL3pp_keyboard.h:491
constexpr TextInputType TEXTINPUT_TYPE_TEXT_USERNAME
The input is a username.
Definition SDL3pp_keyboard.h:453
SDL_TextInputType TextInputType
Text input type.
Definition SDL3pp_keyboard.h:442
Scancode GetScancode(Keymod *modstate) const
Get the scancode corresponding to the given key code according to the current keyboard layout.
Definition SDL3pp_keyboard.h:255
bool IsTextInputActive() const
Check whether or not Unicode text input events are enabled for a window.
Definition SDL3pp_keyboard.h:527
constexpr TextInputType TEXTINPUT_TYPE_TEXT
The input is text.
Definition SDL3pp_keyboard.h:444
constexpr Capitalization CAPITALIZE_NONE
No auto-capitalization will be done.
Definition SDL3pp_keyboard.h:488
SDL_Capitalization Capitalization
Auto capitalization type.
Definition SDL3pp_keyboard.h:486
const char * GetName() const
Get a human-readable name for a scancode.
Definition SDL3pp_keyboard.h:302
constexpr Capitalization CAPITALIZE_WORDS
The first letter of words will be capitalized.
Definition SDL3pp_keyboard.h:495
void StartTextInput()
Start accepting Unicode text input events in a window.
Definition SDL3pp_keyboard.h:373
constexpr TextInputType TEXTINPUT_TYPE_NUMBER
The input is a number.
Definition SDL3pp_keyboard.h:464
void SetTextInputArea(const SDL_Rect &rect, int cursor)
Set the area used to type Unicode text input.
Definition SDL3pp_keyboard.h:587
constexpr TextInputType TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE
The input is a secure password that is visible.
Definition SDL3pp_keyboard.h:460
void ClearComposition()
Dismiss the composition window/IME without disabling the subsystem.
Definition SDL3pp_keyboard.h:563
constexpr TextInputType TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE
The input is a secure PIN that is visible.
Definition SDL3pp_keyboard.h:471
constexpr Capitalization CAPITALIZE_LETTERS
All letters will be capitalized.
Definition SDL3pp_keyboard.h:498
bool HasScreenKeyboardSupport()
Check whether the platform has screen keyboard support.
Definition SDL3pp_keyboard.h:627
Uint16 Keymod
Valid key modifiers (possibly OR'd together).
Definition SDL3pp_keycode.h:29
the main namespace where all SDL3pp public functions and types live
Definition SDL3pp_assert.h:7
Wrap properties id.
Definition SDL3pp_properties.h:203
A rectangle, with the origin at the upper left (using integers).
Definition SDL3pp_rect.h:817
Handle to a non owned window.
Definition SDL3pp_video.h:2781