Mercurial > sdl-ios-xcode
view docs/man3/SDL_GetKeyState.3 @ 121:43febd46d49d
Name changed from OBSD to OPENBSD_AUDIO
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Mon, 23 Jul 2001 02:58:42 +0000 |
parents | 55f1f1b3e27d |
children | e5bc29de3f0a |
line wrap: on
line source
.TH "SDL_GetKeyState" "3" "Sun 10 Jun 2001, 19:40" "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\&. .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, Sun 10 Jun 2001, 19:40