mirror of
https://github.com/joel16/SDL2.git
synced 2024-12-14 14:59:43 +00:00
39 lines
1.4 KiB
Groff
39 lines
1.4 KiB
Groff
.TH "SDL_KeyboardEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference"
|
|
.SH "NAME"
|
|
SDL_KeyboardEvent\- Keyboard event structure
|
|
.SH "STRUCTURE DEFINITION"
|
|
.PP
|
|
.nf
|
|
\f(CWtypedef struct{
|
|
Uint8 type;
|
|
Uint8 state;
|
|
SDL_keysym keysym;
|
|
} SDL_KeyboardEvent;\fR
|
|
.fi
|
|
.PP
|
|
.SH "STRUCTURE DATA"
|
|
.TP 20
|
|
\fBtype\fR
|
|
\fBSDL_KEYDOWN\fP or \fBSDL_KEYUP\fP
|
|
.TP 20
|
|
\fBstate\fR
|
|
\fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP
|
|
.TP 20
|
|
\fBkeysym\fR
|
|
Contains key press information
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\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\&.
|
|
.PP
|
|
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\&.
|
|
.PP
|
|
.RS
|
|
\fBNote:
|
|
.PP
|
|
Repeating \fBSDL_KEYDOWN\fP events will occur if key repeat is enabled (see \fI\fBSDL_EnableKeyRepeat\fP\fR)\&.
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_keysym\fR\fR, \fI\fBSDL_EnableKeyRepeat\fP\fR, \fI\fBSDL_EnableUNICODE\fP\fR
|
|
...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03
|