view docs/man3/SDL_GetKeyState.3 @ 1194:b8f167923bfc

Date: Sun, 04 Dec 2005 21:43:46 -0500 From: Jonathan Atkins <jcatki@jcatki.no-ip.org> Subject: SDL patch: DGA key events I kept seeing DGA die on me whenever I press a key. I tracked it down and it seems that the new indirect X via pointers system messed it up. It needed to have the pX* pointers well defined to call, in particular, pXNextEvent. Also, the X11_TranslateKey function prototype was changed, but not updated in the dga driver. perhaps other files are also affected. Not sure what releases may suffer from this too. thanks! -Jon Atkins
author Ryan C. Gordon <icculus@icculus.org>
date Mon, 05 Dec 2005 04:36:53 +0000
parents e5bc29de3f0a
children 546f7c1eb755
line wrap: on
line source

.TH "SDL_GetKeyState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_GetKeyState\- Get a snapshot of the current keyboard state
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBUint8 *\fBSDL_GetKeyState\fP\fR(\fBint *numkeys\fR);
.SH "DESCRIPTION"
.PP
Gets a snapshot of the current keyboard state\&. The current state is return as a pointer to an array, the size of this array is stored in \fBnumkeys\fR\&. The array is indexed by the \fI\fBSDLK_*\fP\fR symbols\&. A value of 1 means the key is pressed and a value of 0 means its not\&. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller\&.
.PP
.RS
\fBNote:  
.PP
Use \fI\fBSDL_PumpEvents\fP\fR to update the state array\&.
.RE
.SH "EXAMPLE"
.PP
.PP
.nf
\f(CWUint8 *keystate = SDL_GetKeyState(NULL);
if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed\&.
");\fR
.fi
.PP
.SH "SEE ALSO"
.PP
\fI\fBSDL Key Symbols\fP\fR, \fI\fBSDL_PumpEvents\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59