sdl.keyboard

SDL Keyboard Handling

Public Imports

sdl.keycode
public import sdl.keycode;
Undocumented in source.
sdl.scancode
public import sdl.scancode;
Undocumented in source.

Members

Aliases

SDL_KeyboardID
alias SDL_KeyboardID = Uint32

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.

Enums

SDL_Capitalization
enum SDL_Capitalization

Auto capitalization type.

SDL_TextInputType
enum SDL_TextInputType

Text input type.

Functions

SDL_ClearComposition
bool SDL_ClearComposition(SDL_Window* window)

Dismiss the composition window/IME without disabling the subsystem.

SDL_GetKeyFromName
SDL_Keycode SDL_GetKeyFromName(const(char)* name)

Get a key code from a human-readable name.

SDL_GetKeyFromScancode
SDL_Keycode SDL_GetKeyFromScancode(SDL_Scancode scancode, SDL_Keymod modstate, bool key_event)

Get the key code corresponding to the given scancode according to the current keyboard layout.

SDL_GetKeyName
const(char)* SDL_GetKeyName(SDL_Keycode key)

Get a human-readable name for a key.

SDL_GetKeyboardFocus
SDL_Window* SDL_GetKeyboardFocus()

Query the window which currently has keyboard focus.

SDL_GetKeyboardNameForID
const(char)* SDL_GetKeyboardNameForID(SDL_KeyboardID instance_id)

Get the name of a keyboard.

SDL_GetKeyboardState
const(bool)* SDL_GetKeyboardState(int* numkeys)

Get a snapshot of the current state of the keyboard.

SDL_GetKeyboards
SDL_KeyboardID* SDL_GetKeyboards(int* count)

Get a list of currently connected keyboards.

SDL_GetModState
SDL_Keymod SDL_GetModState()

Get the current key modifier state for the keyboard.

SDL_GetScancodeFromKey
SDL_Scancode SDL_GetScancodeFromKey(SDL_Keycode key, SDL_Keymod* modstate)

Get the scancode corresponding to the given key code according to the current keyboard layout.

SDL_GetScancodeFromName
SDL_Scancode SDL_GetScancodeFromName(const(char)* name)

Get a scancode from a human-readable name.

SDL_GetScancodeName
const(char)* SDL_GetScancodeName(SDL_Scancode scancode)

Get a human-readable name for a scancode.

SDL_GetTextInputArea
bool SDL_GetTextInputArea(SDL_Window* window, SDL_Rect* rect, int* cursor)

Get the area used to type Unicode text input.

SDL_HasKeyboard
bool SDL_HasKeyboard()

Return whether a keyboard is currently connected.

SDL_HasScreenKeyboardSupport
bool SDL_HasScreenKeyboardSupport()

Check whether the platform has screen keyboard support.

SDL_ResetKeyboard
void SDL_ResetKeyboard()

Clear the state of the keyboard.

SDL_ScreenKeyboardShown
bool SDL_ScreenKeyboardShown(SDL_Window* window)

Check whether the screen keyboard is shown for given window.

SDL_SetModState
void SDL_SetModState(SDL_Keymod modstate)

Set the current key modifier state for the keyboard.

SDL_SetScancodeName
bool SDL_SetScancodeName(SDL_Scancode scancode, const(char)* name)

Set a human-readable name for a scancode.

SDL_SetTextInputArea
bool SDL_SetTextInputArea(SDL_Window* window, SDL_Rect* rect, int cursor)

Set the area used to type Unicode text input.

SDL_StartTextInput
bool SDL_StartTextInput(SDL_Window* window)

Start accepting Unicode text input events in a window.

SDL_StartTextInputWithProperties
bool SDL_StartTextInputWithProperties(SDL_Window* window, SDL_PropertiesID props)

Start accepting Unicode text input events in a window, with properties describing the input.

SDL_StopTextInput
bool SDL_StopTextInput(SDL_Window* window)

Stop receiving any text input events in a window.

SDL_TextInputActive
bool SDL_TextInputActive(SDL_Window* window)

Check whether or not Unicode text input events are enabled for a window.

Manifest constants

SDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER
enum SDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN
enum SDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER
enum SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN
enum SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_TEXTINPUT_TYPE_NUMBER
enum SDL_PROP_TEXTINPUT_TYPE_NUMBER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

See Also

Meta

License

Subject to the terms of the Zlib License, as written in the LICENSE file.

Authors

Luna Nielsen