Go to the source code of this file.
◆ SDL_KeyboardID
CategoryKeyboard
SDL keyboard management. This is a unique ID for a keyboard for the time it is connected to the system, and is never reused for the lifetime of the application.
If the keyboard is disconnected and reconnected, it will get a new ID.
The ID value starts at 1 and increments from there. The value 0 is an invalid ID.
- Since
- This datatype is available since SDL 3.0.0.
Definition at line 53 of file SDL_keyboard.h.
◆ SDL_ClearComposition()
Dismiss the composition window/IME without disabling the subsystem.
- Parameters
-
window | the window to affect. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_StartTextInput
-
SDL_StopTextInput
◆ SDL_GetDefaultKeyFromScancode()
Get the key code corresponding to the given scancode according to a default en_US keyboard layout.
See SDL_Keycode for details.
- Parameters
-
scancode | the desired SDL_Scancode to query. |
modstate | the modifier state to use when translating the scancode to a keycode. |
- Returns
- the SDL_Keycode that corresponds to the given SDL_Scancode.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetKeyName
-
SDL_GetScancodeFromKey
◆ SDL_GetDefaultScancodeFromKey()
Get the scancode corresponding to the given key code according to a default en_US keyboard layout.
Note that there may be multiple scancode+modifier states that can generate this keycode, this will just return the first one found.
- Parameters
-
key | the desired SDL_Keycode to query. |
modstate | a pointer to the modifier state that would be used when the scancode generates this key, may be NULL. |
- Returns
- the SDL_Scancode that corresponds to the given SDL_Keycode.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetScancodeFromKey
-
SDL_GetScancodeName
◆ SDL_GetKeyboardFocus()
Query the window which currently has keyboard focus.
- Returns
- the window with keyboard focus.
- Since
- This function is available since SDL 3.0.0.
◆ SDL_GetKeyboardNameForID()
Get the name of a keyboard.
This function returns "" if the keyboard doesn't have a name.
- Parameters
-
instance_id | the keyboard instance ID. |
- Returns
- the name of the selected keyboard or NULL on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetKeyboards
◆ SDL_GetKeyboards()
Get a list of currently connected keyboards.
Note that this will include any device or virtual driver that includes keyboard functionality, including some mice, KVM switches, motherboard power buttons, etc. You should wait for input from a device before you consider it actively in use.
- Parameters
-
count | a pointer filled in with the number of keyboards returned, may be NULL. |
- Returns
- a 0 terminated array of keyboards instance IDs or NULL on failure; call SDL_GetError() for more information. This should be freed with SDL_free() when it is no longer needed.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetKeyboardNameForID
-
SDL_HasKeyboard
◆ SDL_GetKeyboardState()
const Uint8 * SDL_GetKeyboardState |
( |
int * |
numkeys | ) |
|
|
extern |
Get a snapshot of the current state of the keyboard.
The pointer returned is a pointer to an internal SDL array. It will be valid for the whole lifetime of the application and should not be freed by the caller.
A array element with a value of 1 means that the key is pressed and a value of 0 means that it is not. Indexes into this array are obtained by using SDL_Scancode values.
Use SDL_PumpEvents() to update the state array.
This function gives you the current state after all events have been processed, so if a key or button has been pressed and released before you process events, then the pressed state will never show up in the SDL_GetKeyboardState() calls.
Note: This function doesn't take into account whether shift has been pressed or not.
- Parameters
-
numkeys | if non-NULL, receives the length of the returned array. |
- Returns
- a pointer to an array of key states.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_PumpEvents
-
SDL_ResetKeyboard
◆ SDL_GetKeyFromName()
◆ SDL_GetKeyFromScancode()
Get the key code corresponding to the given scancode according to the current keyboard layout.
See SDL_Keycode for details.
- Parameters
-
scancode | the desired SDL_Scancode to query. |
modstate | the modifier state to use when translating the scancode to a keycode. |
- Returns
- the SDL_Keycode that corresponds to the given SDL_Scancode.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetDefaultKeyFromScancode
-
SDL_GetKeyName
-
SDL_GetScancodeFromKey
◆ SDL_GetKeyName()
Get a human-readable name for a key.
Both lowercase and uppercase alphabetic keycodes have uppercase names, e.g. SDL_Keycode 'a' and 'A' both have the name "A".
If the key doesn't have a name, this function returns an empty string ("").
- Parameters
-
key | the desired SDL_Keycode to query. |
- Returns
- a UTF-8 encoded string of the key name.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetKeyFromName
-
SDL_GetKeyFromScancode
-
SDL_GetScancodeFromKey
◆ SDL_GetModState()
Get the current key modifier state for the keyboard.
- Returns
- an OR'd combination of the modifier keys for the keyboard. See SDL_Keymod for details.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetKeyboardState
-
SDL_SetModState
◆ SDL_GetScancodeFromKey()
Get the scancode corresponding to the given key code according to the current keyboard layout.
Note that there may be multiple scancode+modifier states that can generate this keycode, this will just return the first one found.
- Parameters
-
key | the desired SDL_Keycode to query. |
modstate | a pointer to the modifier state that would be used when the scancode generates this key, may be NULL. |
- Returns
- the SDL_Scancode that corresponds to the given SDL_Keycode.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetDefaultScancodeFromKey
-
SDL_GetKeyFromScancode
-
SDL_GetScancodeName
◆ SDL_GetScancodeFromName()
◆ SDL_GetScancodeName()
Get a human-readable name for a scancode.
Warning: The returned name is by design not stable across platforms, e.g. the name for SDL_SCANCODE_LGUI
is "Left GUI" under Linux but "Left
Windows" under Microsoft Windows, and some scancodes like SDL_SCANCODE_NONUSBACKSLASH
don't have any name at all. There are even scancodes that share names, e.g. SDL_SCANCODE_RETURN
and SDL_SCANCODE_RETURN2
(both called "Return"). This function is therefore unsuitable for creating a stable cross-platform two-way mapping between strings and scancodes.
- Parameters
-
scancode | the desired SDL_Scancode to query. |
- Returns
- a pointer to the name for the scancode. If the scancode doesn't have a name this function returns an empty string ("").
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetScancodeFromKey
-
SDL_GetScancodeFromName
-
SDL_SetScancodeName
◆ SDL_GetTextInputArea()
Get the area used to type Unicode text input.
This returns the values previously set by SDL_SetTextInputArea().
- Parameters
-
window | the window for which to query the text input area. |
rect | a pointer to an SDL_Rect filled in with the text input area, may be NULL. |
cursor | a pointer to the offset of the current cursor location relative to rect->x , may be NULL. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_SetTextInputArea
◆ SDL_HasKeyboard()
Return whether a keyboard is currently connected.
- Returns
- SDL_TRUE if a keyboard is connected, SDL_FALSE otherwise.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetKeyboards
◆ SDL_HasScreenKeyboardSupport()
SDL_bool SDL_HasScreenKeyboardSupport |
( |
void |
| ) |
|
|
extern |
Check whether the platform has screen keyboard support.
- Returns
- SDL_TRUE if the platform has some screen keyboard support or SDL_FALSE if not.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_StartTextInput
-
SDL_ScreenKeyboardShown
◆ SDL_ResetKeyboard()
void SDL_ResetKeyboard |
( |
void |
| ) |
|
|
extern |
Clear the state of the keyboard.
This function will generate key up events for all pressed keys.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetKeyboardState
◆ SDL_ScreenKeyboardShown()
Check whether the screen keyboard is shown for given window.
- Parameters
-
window | the window for which screen keyboard should be queried. |
- Returns
- SDL_TRUE if screen keyboard is shown or SDL_FALSE if not.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_HasScreenKeyboardSupport
◆ SDL_SetModState()
Set the current key modifier state for the keyboard.
The inverse of SDL_GetModState(), SDL_SetModState() allows you to impose modifier key states on your application. Simply pass your desired modifier states into modstate
. This value may be a bitwise, OR'd combination of SDL_Keymod values.
This does not change the keyboard state, only the key modifier flags that SDL reports.
- Parameters
-
modstate | the desired SDL_Keymod for the keyboard. |
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetModState
◆ SDL_SetScancodeName()
int SDL_SetScancodeName |
( |
SDL_Scancode |
scancode, |
|
|
const char * |
name |
|
) |
| |
|
extern |
Set a human-readable name for a scancode.
- Parameters
-
scancode | the desired SDL_Scancode. |
name | the name to use for the scancode, encoded as UTF-8. The string is not copied, so the pointer given to this function must stay valid while SDL is being used. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetScancodeName
◆ SDL_SetTextInputArea()
Set the area used to type Unicode text input.
Native input methods may place a window with word suggestions near the cursor, without covering the text being entered.
- Parameters
-
window | the window for which to set the text input area. |
rect | the SDL_Rect representing the text input area, in window coordinates, or NULL to clear it. |
cursor | the offset of the current cursor location relative to rect->x , in window coordinates. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_GetTextInputArea
-
SDL_StartTextInput
◆ SDL_StartTextInput()
Start accepting Unicode text input events in a window.
This function will enable text input (SDL_EVENT_TEXT_INPUT and SDL_EVENT_TEXT_EDITING events) in the specified window. Please use this function paired with SDL_StopTextInput().
Text input events are not received by default.
On some platforms using this function shows the screen keyboard.
- Parameters
-
window | the window to enable text input. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_SetTextInputArea
-
SDL_StopTextInput
-
SDL_TextInputActive
◆ SDL_StopTextInput()
Stop receiving any text input events in a window.
If SDL_StartTextInput() showed the screen keyboard, this function will hide it.
- Parameters
-
window | the window to disable text input. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_StartTextInput
◆ SDL_TextInputActive()
Check whether or not Unicode text input events are enabled for a window.
- Parameters
-
window | the window to check. |
- Returns
- SDL_TRUE if text input events are enabled else SDL_FALSE.
- Since
- This function is available since SDL 3.0.0.
- See also
- SDL_StartTextInput