1#ifndef SDL3PP_KEYBOARD_H_
2#define SDL3PP_KEYBOARD_H_
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"
72 auto data =
CheckError(SDL_GetKeyboards(&count));
93 return SDL_GetKeyboardNameForID(instance_id);
140 auto data = SDL_GetKeyboardState(&count);
141 return std::span{data, size_t(count)};
216 :
Keycode(SDL_GetKeyFromScancode(scancode, modstate, key_event))
236 :
Keycode(SDL_GetKeyFromName(name))
260 return SDL_GetScancodeFromKey(m_keycode, modstate);
279 CheckError(SDL_SetScancodeName(m_scancode, name));
307 return SDL_GetScancodeName(m_scancode);
326 :
Scancode(SDL_GetScancodeFromName(name))
349 return SDL_GetKeyName(m_keycode);
448 SDL_TEXTINPUT_TYPE_TEXT;
451 SDL_TEXTINPUT_TYPE_TEXT_NAME;
454 SDL_TEXTINPUT_TYPE_TEXT_EMAIL;
457 SDL_TEXTINPUT_TYPE_TEXT_USERNAME;
460 SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN;
464 SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE;
468 SDL_TEXTINPUT_TYPE_NUMBER;
471 SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN;
475 SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE;
495 SDL_CAPITALIZE_SENTENCES;
499 SDL_CAPITALIZE_WORDS;
502 SDL_CAPITALIZE_LETTERS;
504namespace prop::TextInput {
506constexpr auto TYPE_NUMBER = SDL_PROP_TEXTINPUT_TYPE_NUMBER;
508constexpr auto CAPITALIZATION_NUMBER = SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER;
510constexpr auto AUTOCORRECT_BOOLEAN = SDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN;
512constexpr auto MULTILINE_BOOLEAN = SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN;
514constexpr auto ANDROID_INPUTTYPE_NUMBER =
515 SDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER;
532 return SDL_TextInputActive(
get());
629 return SDL_HasScreenKeyboardSupport();
645 return SDL_ScreenKeyboardShown(
get());
The SDL virtual key representation.
Definition SDL3pp_keycode.h:113
constexpr Keycode(SDL_Keycode keycode={})
Wraps Keycode.
Definition SDL3pp_keycode.h:122
Base class for SDL memory allocated array wrap.
Definition SDL3pp_ownPtr.h:43
constexpr SDL_Window * get() const
Return contained resource;.
Definition SDL3pp_resource.h:76
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:470
void SetName(StringParam name)
Set a human-readable name for a scancode.
Definition SDL3pp_keyboard.h:277
const char * GetName() const
Get a human-readable name for a key.
Definition SDL3pp_keyboard.h:347
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
void ResetKeyboard()
Clear the state of the keyboard.
Definition SDL3pp_keyboard.h:155
bool IsScreenKeyboardShown() const
Check whether the screen keyboard is shown for given window.
Definition SDL3pp_keyboard.h:643
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:191
void StopTextInput()
Stop receiving any text input events in a window.
Definition SDL3pp_keyboard.h:549
constexpr TextInputType TEXTINPUT_TYPE_TEXT_NAME
The input is a person's name.
Definition SDL3pp_keyboard.h:450
Keymod GetModState()
Get the current key modifier state for the keyboard.
Definition SDL3pp_keyboard.h:170
const char * GetKeyboardNameForID(KeyboardID instance_id)
Get the name of a keyboard.
Definition SDL3pp_keyboard.h:91
WindowRef GetKeyboardFocus()
Query the window which currently has keyboard focus.
Definition SDL3pp_keyboard.h:105
constexpr TextInputType TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN
The input is a secure password that is hidden.
Definition SDL3pp_keyboard.h:459
constexpr TextInputType TEXTINPUT_TYPE_TEXT_EMAIL
The input is an e-mail address.
Definition SDL3pp_keyboard.h:453
constexpr Capitalization CAPITALIZE_SENTENCES
The first letter of sentences will be capitalized.
Definition SDL3pp_keyboard.h:494
void StartTextInput()
Start accepting Unicode text input events in a window.
Definition SDL3pp_keyboard.h:376
OwnArray< KeyboardID > GetKeyboards()
Get a list of currently connected keyboards.
Definition SDL3pp_keyboard.h:69
constexpr TextInputType TEXTINPUT_TYPE_TEXT_USERNAME
The input is a username.
Definition SDL3pp_keyboard.h:456
SDL_TextInputType TextInputType
Text input type.
Definition SDL3pp_keyboard.h:445
Scancode GetScancode(Keymod *modstate) const
Get the scancode corresponding to the given key code according to the current keyboard layout.
Definition SDL3pp_keyboard.h:258
void ClearComposition()
Dismiss the composition window/IME without disabling the subsystem.
Definition SDL3pp_keyboard.h:563
constexpr TextInputType TEXTINPUT_TYPE_TEXT
The input is text.
Definition SDL3pp_keyboard.h:447
void SetTextInputArea(const SDL_Rect &rect, int cursor)
Set the area used to type Unicode text input.
Definition SDL3pp_keyboard.h:587
constexpr Capitalization CAPITALIZE_NONE
No auto-capitalization will be done.
Definition SDL3pp_keyboard.h:491
SDL_Capitalization Capitalization
Auto capitalization type.
Definition SDL3pp_keyboard.h:489
void GetTextInputArea(Rect *rect, int *cursor)
Get the area used to type Unicode text input.
Definition SDL3pp_keyboard.h:609
const char * GetName() const
Get a human-readable name for a scancode.
Definition SDL3pp_keyboard.h:305
constexpr Capitalization CAPITALIZE_WORDS
The first letter of words will be capitalized.
Definition SDL3pp_keyboard.h:498
constexpr TextInputType TEXTINPUT_TYPE_NUMBER
The input is a number.
Definition SDL3pp_keyboard.h:467
constexpr TextInputType TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE
The input is a secure password that is visible.
Definition SDL3pp_keyboard.h:463
constexpr TextInputType TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE
The input is a secure PIN that is visible.
Definition SDL3pp_keyboard.h:474
constexpr Capitalization CAPITALIZE_LETTERS
All letters will be capitalized.
Definition SDL3pp_keyboard.h:501
bool HasScreenKeyboardSupport()
Check whether the platform has screen keyboard support.
Definition SDL3pp_keyboard.h:627
std::span< const bool > GetKeyboardState()
Get a snapshot of the current state of the keyboard.
Definition SDL3pp_keyboard.h:137
bool IsTextInputActive() const
Check whether or not Unicode text input events are enabled for a window.
Definition SDL3pp_keyboard.h:530
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
SDL properties ID.
Definition SDL3pp_properties.h:209
A rectangle, with the origin at the upper left (using integers).
Definition SDL3pp_rect.h:833
Represents a handle to a window.
Definition SDL3pp_video.h:860