|
Size: 794
Comment: Updated.
|
Size: 818
Comment: Tweaked language
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 24: | Line 24: |
| Registering zero events is an error and will return (Uint32)-1. | Calling this function with '''numevents''' <= 0 is an error and will return (Uint32)-1. |
SDL_RegisterEvents
Use this function to allocate a set of user-defined events, and return the beginning event number for that set of events.
Contents
Syntax
Uint32 SDL_RegisterEvents(int numevents)
Function Parameters
numevents |
the number of events to be allocated |
Return Value
The beginning event number, or (Uint32)-1 if there are not enough user-defined events left.
Code Examples
Uint32 myEventType = SDL_RegisterEvents(1);
if (myEventType != ((Uint32)-1)) {
SDL_Event event;
SDL_memset(&event, 0, sizeof(event)); /* or 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
Calling this function with numevents <= 0 is an error and will return (Uint32)-1.
