Annotated edit history of
SDL_UserEvent(3) version 2, including all changes.
View license author blame.
| Rev |
Author |
# |
Line |
| 2 |
perry |
1 |
SDL_!UserEvent |
| |
|
2 |
!!!SDL_!UserEvent |
| 1 |
perry |
3 |
NAME |
| |
|
4 |
STRUCTURE DEFINITION |
| |
|
5 |
STRUCTURE DATA |
| |
|
6 |
DESCRIPTION |
| |
|
7 |
EXAMPLES |
| |
|
8 |
SEE ALSO |
| |
|
9 |
---- |
| |
|
10 |
!!NAME |
| |
|
11 |
|
| |
|
12 |
|
| 2 |
perry |
13 |
SDL_!UserEvent- A user-defined event type |
| 1 |
perry |
14 |
!!STRUCTURE DEFINITION |
| |
|
15 |
|
| |
|
16 |
|
| |
|
17 |
typedef struct{ |
| |
|
18 |
Uint8 type; |
| |
|
19 |
int code; |
| |
|
20 |
void *data1; |
| |
|
21 |
void *data2; |
| 2 |
perry |
22 |
} SDL_!UserEvent; |
| 1 |
perry |
23 |
!!STRUCTURE DATA |
| |
|
24 |
|
| |
|
25 |
|
| |
|
26 |
__type SDL_USEREVENT__ through to |
| |
|
27 |
__SDL_NUMEVENTS-1__ |
| |
|
28 |
|
| |
|
29 |
|
| |
|
30 |
__code__ User defined event code |
| |
|
31 |
|
| |
|
32 |
|
| |
|
33 |
__data1__ User defined data pointer |
| |
|
34 |
|
| |
|
35 |
|
| |
|
36 |
__data2__ User defined data pointer |
| |
|
37 |
!!DESCRIPTION |
| |
|
38 |
|
| |
|
39 |
|
| 2 |
perry |
40 |
__SDL_!UserEvent__ is in the __user__ member of the |
| 1 |
perry |
41 |
structure __SDL_Event__. This event is unique, it is |
| |
|
42 |
never created by SDL but only by the user. The event can be |
| 2 |
perry |
43 |
pushed onto the event queue using __SDL_!PushEvent__. The |
| 1 |
perry |
44 |
contents of the structure members or completely up to the |
| |
|
45 |
programmer, the only requirement is that __type__ is a |
| |
|
46 |
value from __SDL_USEREVENT__ to __SDL_NUMEVENTS-1__ |
| |
|
47 |
(inclusive). |
| |
|
48 |
!!EXAMPLES |
| |
|
49 |
|
| |
|
50 |
|
| |
|
51 |
SDL_Event event; |
| |
|
52 |
event.type = SDL_USEREVENT; |
| |
|
53 |
event.user.code = my_event_code; |
| |
|
54 |
event.user.data1 = significant_data; |
| |
|
55 |
event.user.data2 = 0; |
| 2 |
perry |
56 |
SDL_!PushEvent( |
| 1 |
perry |
57 |
!!SEE ALSO |
| |
|
58 |
|
| |
|
59 |
|
| 2 |
perry |
60 |
__SDL_Event__, __SDL_!PushEvent__ |
| 1 |
perry |
61 |
---- |
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.