1 .TH "SDL_KeyboardEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 

     2 .SH "NAME"

     3 SDL_KeyboardEvent \- Keyboard event structure

     4 .SH "STRUCTURE DEFINITION"

     5 .PP

     6 .nf

     7 \f(CWtypedef struct{

     8   Uint8 type;

     9   Uint8 state;

    10   SDL_keysym keysym;

    11 } SDL_KeyboardEvent;\fR

    12 .fi

    13 .PP

    14 .SH "STRUCTURE DATA"

    15 .TP 20

    16 \fBtype\fR

    17 \fBSDL_KEYDOWN\fP or \fBSDL_KEYUP\fP

    18 .TP 20

    19 \fBstate\fR

    20 \fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP

    21 .TP 20

    22 \fBkeysym\fR

    23 Contains key press information

    24 .SH "DESCRIPTION"

    25 .PP

    26 \fBSDL_KeyboardEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_KEYDOWN\fP or \fBSDL_KEYUP\fP is reported\&.

    27 .PP

    28 The \fBtype\fR and \fBstate\fR actually report the same information, they just use different values to do it! A keyboard event occurs when a key is released (\fBtype\fR=\fBSDK_KEYUP\fP or \fBstate\fR=\fBSDL_RELEASED\fP) and when a key is pressed (\fBtype\fR=\fBSDL_KEYDOWN\fP or \fBstate\fR=\fBSDL_PRESSED\fP)\&. The information on what key was pressed or released is in the \fI\fBkeysym\fR\fR structure\&.

    29 .PP

    30 .RS

    31 \fBNote:  

    32 .PP

    33 Repeating \fBSDL_KEYDOWN\fP events will occur if key repeat is enabled (see \fI\fBSDL_EnableKeyRepeat\fP\fR)\&.

    34 .RE

    35 .SH "SEE ALSO"

    36 .PP

    37 \fI\fBSDL_Event\fR\fR, \fI\fBSDL_keysym\fR\fR, \fI\fBSDL_EnableKeyRepeat\fP\fR, \fI\fBSDL_EnableUNICODE\fP\fR

    38 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59