"SDL_UserEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
"NAME"
SDL_UserEvent - A user-defined event type
"STRUCTURE DEFINITION"
typedef struct{
Uint8 type;
int code;
void *data1;
void *data2;
} SDL_UserEvent;
"STRUCTURE DATA"
20 type SDL_USEREVENT through to SDL_NUMEVENTS-1
20 code User defined event code
20 data1 User defined data pointer
20 data2 User defined data pointer
"DESCRIPTION"
SDL_UserEvent is in the user member of the structure SDL_Event. This event is unique, it is never created by SDL but only by the user. The event can be pushed onto the event queue using SDL_PushEvent. The contents of the structure members or completely up to the programmer, the only requirement is that type is a value from SDL_USEREVENT to SDL_NUMEVENTS-1 (inclusive).
"EXAMPLES"
SDL_Event event;
event.type = SDL_USEREVENT;
event.user.code = my_event_code;
event.user.data1 = significant_data;
event.user.data2 = 0;
SDL_PushEvent(&event);
"SEE ALSO"
SDL_Event, SDL_PushEvent
created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00
