View Source: SDL_keysym(3) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

SDL_keysym
!!!SDL_keysym
NAME
STRUCTURE DEFINITION
STRUCTURE DATA
DESCRIPTION
SEE ALSO
----
!!NAME


SDL_keysym- Keysym structure
!!STRUCTURE DEFINITION


typedef struct{
Uint8 scancode;
SDLKey sym;
SDLMod mod;
Uint16 unicode;
} SDL_keysym;
!!STRUCTURE DATA


__scancode__ Hardware specific scancode


__sym__ SDL virtual keysym


__mod__ Current key modifiers


__unicode__ Translated character
!!DESCRIPTION


The __SDL_keysym__ structure is used by reporting key
presses and releases since it is a part of the
__SDL_!KeyboardEvent__.


The __scancode__ field should generally be left alone, it
is the hardware dependent scancode returned by the keyboard.
The __sym__ field is extremely useful. It is the
SDL-defined value of the key (see ''SDL Key Syms''. This
field is very useful when you are checking for certain key
presses, like so:


.
.
while(SDL_!PollEvent(
__mod__ stores the current state of the keyboard modifiers as explained in __SDL_!GetModState__. The __unicode__ is only used when UNICODE translation is enabled with __SDL_EnableUNICODE__. If __unicode__ is non-zero then this a the UNICODE character corresponding to the keypress. If the high 9 bits of the character are 0, then this maps to the equivalent ASCII character:


char ch;
if ( (keysym.unicode
UNICODE translation does have a slight overhead so don't enable it unless its needed.
!!SEE ALSO


__SDLKey__
----

One page links to SDL_keysym(3):

SDLManPages

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Last edited on Monday, June 3, 2002 6:53:50 pm by "perry"

Edit PageHistory Diff Info LikePages