#include "SDL_config.h"
#include "SDL_timer.h"
#include "SDL_events.h"
#include "SDL_events_c.h"
#include "../video/SDL_sysvideo.h"

Typedefs
typedef struct SDL_Keyboard	SDL_Keyboard

Functions
void	SDL_GetDefaultKeymap (SDL_Keycode *keymap)

SDL_Window *	SDL_GetKeyboardFocus (void)
	Get the window which currently has keyboard focus. More...

const Uint8 *	SDL_GetKeyboardState (int *numkeys)
	Get a snapshot of the current state of the keyboard. More...

SDL_Keycode	SDL_GetKeyFromName (const char *name)
	Get a key code from a human-readable name. More...

SDL_Keycode	SDL_GetKeyFromScancode (SDL_Scancode scancode)
	Get the key code corresponding to the given scancode according to the current keyboard layout. More...

const char *	SDL_GetKeyName (SDL_Keycode key)
	Get a human-readable name for a key. More...

SDL_Keymod	SDL_GetModState (void)
	Get the current key modifier state for the keyboard. More...

SDL_Scancode	SDL_GetScancodeFromKey (SDL_Keycode key)
	Get the scancode corresponding to the given key code according to the current keyboard layout. More...

SDL_Scancode	SDL_GetScancodeFromName (const char *name)
	Get a scancode from a human-readable name. More...

const char *	SDL_GetScancodeName (SDL_Scancode scancode)
	Get a human-readable name for a scancode. More...

int	SDL_KeyboardInit (void)

void	SDL_KeyboardQuit (void)

void	SDL_ResetKeyboard (void)

int	SDL_SendEditingText (const char *text, int start, int length)

int	SDL_SendKeyboardKey (Uint8 state, SDL_Scancode scancode)

int	SDL_SendKeyboardText (const char *text)

void	SDL_SetKeyboardFocus (SDL_Window *window)

void	SDL_SetKeymap (int start, SDL_Keycode *keys, int length)

void	SDL_SetModState (SDL_Keymod modstate)
	Set the current key modifier state for the keyboard. More...

void	SDL_SetScancodeName (SDL_Scancode scancode, const char *name)

static char *	SDL_UCS4ToUTF8 (Uint32 ch, char *dst)

Variables
static const SDL_Keycode	SDL_default_keymap [SDL_NUM_SCANCODES]

static SDL_Keyboard	SDL_keyboard

static const char *	SDL_scancode_names [SDL_NUM_SCANCODES]

Typedef Documentation

typedef struct SDL_Keyboard SDL_Keyboard

Definition at line 35 of file SDL_keyboard.c.

Function Documentation

void SDL_GetDefaultKeymap ( SDL_Keycode * keymap )

Definition at line 579 of file SDL_keyboard.c.

References SDL_default_keymap, and SDL_memcpy().

SDL_Window* SDL_GetKeyboardFocus ( void )

Get the window which currently has keyboard focus.

Definition at line 603 of file SDL_keyboard.c.

References SDL_keyboard.

Referenced by SDL_DestroyWindow(), SDL_PrivateJoystickShouldIgnoreEvent(), and SDL_SetRelativeMouseMode().

const Uint8* SDL_GetKeyboardState ( int * numkeys )

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");
*  }
*  

Definition at line 832 of file SDL_keyboard.c.

References SDL_keyboard, and SDL_NUM_SCANCODES.

SDL_Keycode SDL_GetKeyFromName ( const char * name )

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

Definition at line 964 of file SDL_keyboard.c.

References i, NULL, SDL_default_keymap, SDL_GetScancodeFromName(), SDL_strlen(), and SDLK_UNKNOWN.

SDL_Keycode SDL_GetKeyFromScancode ( SDL_Scancode scancode )

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

See SDL_Keycode for details.

See Also: SDL_GetKeyName()

Definition at line 859 of file SDL_keyboard.c.

References SDL_InvalidParamError, SDL_keyboard, and SDL_NUM_SCANCODES.

const char* SDL_GetKeyName ( SDL_Keycode key )

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 ("").