Wiki Page Content

Differences between revisions 14 and 15
Revision 14 as of 2014-07-04 12:17:38
Size: 1441
Comment: SDL_RegisterEvent -> SDL_RegisterEvents (from Feedback).
Revision 15 as of 2015-04-26 19:22:03
Size: 1441
Comment: Sorted related functions, see SGStructures.
Deletions are marked like this. Additions are marked like this.
Line 38: Line 38:
 .[[SDL_PushEvent]]
Line 39: Line 40:
 .[[SDL_PushEvent]]

SDL_UserEvent

A structure that contains an application-defined event type.

Data Fields

Uint32

type

value obtained from SDL_RegisterEvents()

Uint32

timestamp

timestamp of the event

Uint32

windowID

the associated window, if any

Sint32

code

user defined event code

void*

data1

user defined data pointer

void*

data2

user defined data pointer

Code Examples

Uint32 myEventType = SDL_RegisterEvents(1);
if (myEventType != ((Uint32)-1)) {
    SDL_Event event;
    SDL_zero(event);
    event.type = myEventType;
    event.user.code = my_event_code;
    event.user.data1 = significant_data;
    event.user.data2 = 0;
    SDL_PushEvent(&event);
}

Remarks

SDL_UserEvent is in the user member of the SDL_Event union. This event is unique; it is never created by SDL but only by the application. The event can be pushed onto the event queue using SDL_PushEvent(). The contents of the structure members are completely up to the programmer; the only requirement is that type is a value obtained from SDL_RegisterEvents().


CategoryStruct, CategoryEvents

None: SDL_UserEvent (last edited 2015-10-29 21:58:30 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit