SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
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
35using KeyboardID = SDL_KeyboardID;
36
48inline bool HasKeyboard() { return SDL_HasKeyboard(); }
49
70{
71 int count;
72 auto data = CheckError(SDL_GetKeyboards(&count));
73 return OwnArray<KeyboardID>{data, size_t(count)};
74}
75
91inline const char* GetKeyboardNameForID(KeyboardID instance_id)
92{
93 return SDL_GetKeyboardNameForID(instance_id);
94}
95
105inline WindowRef GetKeyboardFocus() { return {SDL_GetKeyboardFocus()}; }
106
137inline std::span<const bool> GetKeyboardState()
138{
139 int count;
140 auto data = SDL_GetKeyboardState(&count);
141 return std::span{data, size_t(count)};
142}
143
155inline void ResetKeyboard() { SDL_ResetKeyboard(); }
156
169inline Keymod GetModState() { return SDL_GetModState(); }
170
189inline void SetModState(Keymod modstate) { SDL_SetModState(modstate); }
190
191inline Keycode::Keycode(Scancode scancode, Keymod modstate, bool key_event)
192 : m_keycode(SDL_GetKeyFromScancode(scancode, modstate, key_event))
193{
194}
195
197 : m_keycode(SDL_GetKeyFromName(name))
198{
199}
200
201inline Scancode Keycode::GetScancode(Keymod* modstate) const
202{
203 return SDL_GetScancodeFromKey(m_keycode, modstate);
204}
205
207{
208 CheckError(SDL_SetScancodeName(m_scancode, name));
209}
210
211inline const char* Scancode::GetName() const
212{
213 return SDL_GetScancodeName(m_scancode);
214}
215
217 : m_scancode(SDL_GetScancodeFromName(name))
218{
219}
220
221inline const char* Keycode::GetName() const
222{
223 return SDL_GetKeyName(m_keycode);
224}
225
227{
228 CheckError(SDL_StartTextInput(m_resource));
229}
230
232{
233 CheckError(SDL_StartTextInputWithProperties(m_resource, props));
234}
235
247using TextInputType = SDL_TextInputType;
248
250 SDL_TEXTINPUT_TYPE_TEXT;
251
253 SDL_TEXTINPUT_TYPE_TEXT_NAME;
254
256 SDL_TEXTINPUT_TYPE_TEXT_EMAIL;
257
259 SDL_TEXTINPUT_TYPE_TEXT_USERNAME;
260
262 SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN;
264
266 SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE;
268
270 SDL_TEXTINPUT_TYPE_NUMBER;
271
273 SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN;
275
277 SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE;
279
291using Capitalization = SDL_Capitalization;
292
294 SDL_CAPITALIZE_NONE;
295
297 SDL_CAPITALIZE_SENTENCES;
299
301 SDL_CAPITALIZE_WORDS;
302
304 SDL_CAPITALIZE_LETTERS;
305
306namespace prop::TextInput {
307
308constexpr auto TYPE_NUMBER = SDL_PROP_TEXTINPUT_TYPE_NUMBER;
309
310constexpr auto CAPITALIZATION_NUMBER = SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER;
311
312constexpr auto AUTOCORRECT_BOOLEAN = SDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN;
313
314constexpr auto MULTILINE_BOOLEAN = SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN;
315
316constexpr auto ANDROID_INPUTTYPE_NUMBER =
317 SDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER;
318
319} // namespace prop::TextInput
320
321inline bool Window::IsTextInputActive() const
322{
323 return SDL_TextInputActive(m_resource);
324}
325
327{
328 CheckError(SDL_StopTextInput(m_resource));
329}
330
332{
333 CheckError(SDL_ClearComposition(m_resource));
334}
335
336inline void Window::SetTextInputArea(const RectRaw& rect, int cursor)
337{
338 CheckError(SDL_SetTextInputArea(m_resource, &rect, cursor));
339}
340
341inline void Window::GetTextInputArea(RectRaw* rect, int* cursor)
342{
343 CheckError(SDL_GetTextInputArea(m_resource, rect, cursor));
344}
345
360{
361 return SDL_HasScreenKeyboardSupport();
362}
363
365{
366 return SDL_ScreenKeyboardShown(m_resource);
367}
368
370
371} // namespace SDL
372
373#endif /* SDL3PP_KEYBOARD_H_ */
constexpr Keycode(KeycodeRaw keycode={}) noexcept
Wraps Keycode.
Definition: SDL3pp_keycode.h:129
Base class for SDL memory allocated array wrap.
Definition: SDL3pp_ownPtr.h:44
The SDL keyboard scancode representation.
Definition: SDL3pp_scancode.h:46
constexpr Scancode(ScancodeRaw scancode={}) noexcept
Wraps Scancode.
Definition: SDL3pp_scancode.h:55
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:197
constexpr TextInputType TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN
The input is a secure PIN that is hidden.
Definition: SDL3pp_keyboard.h:272
void SetName(StringParam name)
Set a human-readable name for a scancode.
Definition: SDL3pp_keyboard.h:206
const char * GetName() const
Get a human-readable name for a key.
Definition: SDL3pp_keyboard.h:221
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:35
void ResetKeyboard()
Clear the state of the keyboard.
Definition: SDL3pp_keyboard.h:155
void GetTextInputArea(RectRaw *rect, int *cursor)
Get the area used to type Unicode text input.
Definition: SDL3pp_keyboard.h:341
bool HasKeyboard()
Return whether a keyboard is currently connected.
Definition: SDL3pp_keyboard.h:48
void ClearComposition()
Dismiss the composition window/IME without disabling the subsystem.
Definition: SDL3pp_keyboard.h:331
void SetModState(Keymod modstate)
Set the current key modifier state for the keyboard.
Definition: SDL3pp_keyboard.h:189
constexpr TextInputType TEXTINPUT_TYPE_TEXT_NAME
The input is a person's name.
Definition: SDL3pp_keyboard.h:252
Keymod GetModState()
Get the current key modifier state for the keyboard.
Definition: SDL3pp_keyboard.h:169
const char * GetKeyboardNameForID(KeyboardID instance_id)
Get the name of a keyboard.
Definition: SDL3pp_keyboard.h:91
void StartTextInput()
Start accepting Unicode text input events in a window.
Definition: SDL3pp_keyboard.h:226
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:261
constexpr TextInputType TEXTINPUT_TYPE_TEXT_EMAIL
The input is an e-mail address.
Definition: SDL3pp_keyboard.h:255
constexpr Capitalization CAPITALIZE_SENTENCES
The first letter of sentences will be capitalized.
Definition: SDL3pp_keyboard.h:296
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:258
SDL_TextInputType TextInputType
Text input type.
Definition: SDL3pp_keyboard.h:247
bool IsTextInputActive() const
Check whether or not Unicode text input events are enabled for a window.
Definition: SDL3pp_keyboard.h:321
Scancode GetScancode(Keymod *modstate) const
Get the scancode corresponding to the given key code according to the current keyboard layout.
Definition: SDL3pp_keyboard.h:201
void StopTextInput()
Stop receiving any text input events in a window.
Definition: SDL3pp_keyboard.h:326
bool IsScreenKeyboardShown() const
Check whether the screen keyboard is shown for given window.
Definition: SDL3pp_keyboard.h:364
constexpr TextInputType TEXTINPUT_TYPE_TEXT
The input is text.
Definition: SDL3pp_keyboard.h:249
constexpr Capitalization CAPITALIZE_NONE
No auto-capitalization will be done.
Definition: SDL3pp_keyboard.h:293
SDL_Capitalization Capitalization
Auto capitalization type.
Definition: SDL3pp_keyboard.h:291
void SetTextInputArea(const RectRaw &rect, int cursor)
Set the area used to type Unicode text input.
Definition: SDL3pp_keyboard.h:336
const char * GetName() const
Get a human-readable name for a scancode.
Definition: SDL3pp_keyboard.h:211
constexpr Capitalization CAPITALIZE_WORDS
The first letter of words will be capitalized.
Definition: SDL3pp_keyboard.h:300
constexpr TextInputType TEXTINPUT_TYPE_NUMBER
The input is a number.
Definition: SDL3pp_keyboard.h:269
constexpr TextInputType TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE
The input is a secure password that is visible.
Definition: SDL3pp_keyboard.h:265
constexpr TextInputType TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE
The input is a secure PIN that is visible.
Definition: SDL3pp_keyboard.h:276
constexpr Capitalization CAPITALIZE_LETTERS
All letters will be capitalized.
Definition: SDL3pp_keyboard.h:303
bool HasScreenKeyboardSupport()
Check whether the platform has screen keyboard support.
Definition: SDL3pp_keyboard.h:359
std::span< const bool > GetKeyboardState()
Get a snapshot of the current state of the keyboard.
Definition: SDL3pp_keyboard.h:137
Uint16 Keymod
Valid key modifiers (possibly OR'd together).
Definition: SDL3pp_keycode.h:34
SDL_Rect RectRaw
Alias to raw representation for Rect.
Definition: SDL3pp_rect.h:34
Main include header for the SDL3pp library.
Safely wrap Properties for non owning parameters.
Definition: SDL3pp_properties.h:53
Semi-safe reference for Window.
Definition: SDL3pp_video.h:3169