Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_GetKeyState.3 @ 911:04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
From: David Symmonds
Subject: SDL Typedef Structs
Hi, Thanks for the SDL libraries, I have been using them for about a year
now and they are really brilliant. One thing that I have just found whilst
using them through C++ (and needing forward declarations) is that when you
typedef structs you sometimes use
typedef struct Name
{
...
}Name;
e.g. SDL_Surface
and other times use
typedef struct
{
...
}Name;
e.g. SDL_Rect
The first type works fine, when I define a header file I can just put
'struct Name;' at the top and use the Name throughout. However, the second
type is harder to use in a header, and I haven't found a way yet, other than
to include 'SDL.h' in the header file (undesirable). Would there be any harm
in changing the definition of SDL_Rect and such like to the second form?
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sun, 18 Jul 2004 22:57:40 +0000 |
parents | e5bc29de3f0a |
children | 546f7c1eb755 |
rev | line source |
---|---|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_GetKeyState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" |
0 | 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 | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
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\&. |
0 | 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 | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
30 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 |