SDL_keyboard.h File Reference

The SDL keysym structure, used in key events.

Note:

If you are looking for translated character input, see the SDL_TEXTINPUT event.

Get the window which currently has keyboard focus.

Get a snapshot of the current state of the keyboard.

Parameters:

numkeys

if non-NULL, receives the length of the returned array.

Returns:

An array of key states. Indexes into this array are obtained by using SDL_Scancode values.

Example:

  const Uint8 *state = SDL_GetKeyboardState(NULL);
  if ( state[SDL_SCANCODE_RETURN] )   {
      printf("<RETURN> is pressed.\n");
  }

Get a key code from a human-readable name.

Returns:

key code, or SDLK_UNKNOWN if the name wasn't recognized

See also:

SDL_Keycode

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

See SDL_Keycode for details.

See also:

SDL_GetKeyName()

Get a human-readable name for a key.

Returns:

A pointer to a UTF-8 string that stays valid at least until the next call to this function. If you need it around any longer, you must copy it. If the key doesn't have a name, this function returns an empty string ("").

See also:

SDL_Key

Get the current key modifier state for the keyboard.

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

See SDL_Scancode for details.

See also:

SDL_GetScancodeName()

Get a scancode from a human-readable name.

Returns:

scancode, or SDL_SCANCODE_UNKNOWN if the name wasn't recognized

See also:

SDL_Scancode

Get a human-readable name for a scancode.

Returns:

A pointer to the name for the scancode. If the scancode doesn't have a name, this function returns an empty string ("").

See also:

SDL_Scancode

Returns whether the platform has some screen keyboard support.

Returns:

SDL_TRUE if some keyboard support is available else SDL_FALSE.

Note:

Not all screen keyboard functions are supported on all platforms.

See also:

SDL_IsScreenKeyboardShown()

Returns 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 else SDL_FALSE.

See also:

SDL_HasScreenKeyboardSupport()

Return whether or not Unicode text input events are enabled.

See also:

SDL_StartTextInput()

SDL_StopTextInput()

Set the current key modifier state for the keyboard.

Note:

This does not change the keyboard state, only the key modifier flags.

Set the rectangle used to type Unicode text inputs.

This is used as a hint for IME and on-screen keyboard placement.

See also:

SDL_StartTextInput()

Start accepting Unicode text input events.

This function will show the on-screen keyboard if supported.

See also:

SDL_StopTextInput()

SDL_SetTextInputRect()

SDL_HasScreenKeyboardSupport()

Stop receiving any text input events.

This function will hide the on-screen keyboard if supported.

See also:

SDL_StartTextInput()

SDL_HasScreenKeyboardSupport()