Mercurial > sdl-ios-xcode

comparison docs/man3/SDL_GetKeyState.3 @ 181:e5bc29de3f0a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated from the SDL Documentation Project
author Sam Lantinga <slouken@libsdl.org>
date Fri, 14 Sep 2001 02:41:09 +0000
parents 55f1f1b3e27d
children 546f7c1eb755
comparison
equal deleted inserted replaced
180:578815880307 181:e5bc29de3f0a
1 .TH "SDL_GetKeyState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" 1 .TH "SDL_GetKeyState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
2 .SH "NAME" 2 .SH "NAME"
3 SDL_GetKeyState\- Get a snapshot of the current keyboard state 3 SDL_GetKeyState\- Get a snapshot of the current keyboard state
4 .SH "SYNOPSIS" 4 .SH "SYNOPSIS"
5 .PP 5 .PP
6 \fB#include "SDL\&.h" 6 \fB#include "SDL\&.h"
7 .sp 7 .sp
8 \fBUint8 *\fBSDL_GetKeyState\fP\fR(\fBint *numkeys\fR); 8 \fBUint8 *\fBSDL_GetKeyState\fP\fR(\fBint *numkeys\fR);
9 .SH "DESCRIPTION" 9 .SH "DESCRIPTION"
10 .PP 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\&. 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 12 .PP
13 .RS 13 .RS
14 \fBNote: 14 \fBNote:
15 .PP 15 .PP
16 Use \fI\fBSDL_PumpEvents\fP\fR to update the state array\&. 16 Use \fI\fBSDL_PumpEvents\fP\fR to update the state array\&.
25 .fi 25 .fi
26 .PP 26 .PP
27 .SH "SEE ALSO" 27 .SH "SEE ALSO"
28 .PP 28 .PP
29 \fI\fBSDL Key Symbols\fP\fR, \fI\fBSDL_PumpEvents\fP\fR 29 \fI\fBSDL Key Symbols\fP\fR, \fI\fBSDL_PumpEvents\fP\fR
30 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 30 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59