| 1 | .TH "SDL_GetKeyState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" |
| 2 | .SH "NAME" |
| 3 | SDL_GetKeyState \- Get a snapshot of the current keyboard state |
| 4 | .SH "SYNOPSIS" |
| 5 | .PP |
| 6 | \fB#include "SDL\&.h" |
| 7 | .sp |
| 8 | \fBUint8 *\fBSDL_GetKeyState\fP\fR(\fBint *numkeys\fR); |
| 9 | .SH "DESCRIPTION" |
| 10 | .PP |
| 11 | 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\&. |
| 12 | .PP |
| 13 | .RS |
| 14 | \fBNote: |
| 15 | .PP |
| 16 | Use \fI\fBSDL_PumpEvents\fP\fR to update the state array\&. |
| 17 | .RE |
| 18 | .SH "EXAMPLE" |
| 19 | .PP |
| 20 | .PP |
| 21 | .nf |
| 22 | \f(CWUint8 *keystate = SDL_GetKeyState(NULL); |
| 23 | if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed\&. |
| 24 | ");\fR |
| 25 | .fi |
| 26 | .PP |
| 27 | .SH "SEE ALSO" |
| 28 | .PP |
| 29 | \fI\fBSDL Key Symbols\fP\fR, \fI\fBSDL_PumpEvents\fP\fR |
| 30 | .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 |