(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_KeyboardEvent

Keyboard button event structure (event.key.*)

Header File

Defined in [SDL_events.h](https://github.com/libsdl-org/SDL/blob/SDL2/include/SDL_events.h), but apps should _only_ `#include "SDL.h"`!

Syntax

typedef struct SDL_KeyboardEvent
{
    Uint32 type;        /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
    Uint32 windowID;    /**< The window with keyboard focus, if any */
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
    Uint8 repeat;       /**< Non-zero if this is a key repeat */
    Uint8 padding2;
    Uint8 padding3;
    SDL_Keysym keysym;  /**< The key that was pressed or released */
} SDL_KeyboardEvent;

Data Fields

Uint32	type	the event type; SDL_KEYDOWN or SDL_KEYUP
Uint32	timestamp	timestamp of the event
Uint32	windowID	the window with keyboard focus, if any
Uint8	state	the state of the key; SDL_PRESSED or SDL_RELEASED
Uint8	repeat	non-zero if this is a key repeat
SDL_Keysym	keysym	the SDL_Keysym representing the key that was pressed or released

Related Enumerations

SDL_EventType

Related Structures

SDL_Event

---

CategoryAPI, CategoryAPIStruct, CategoryStruct, CategoryEvents

---

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.