Function sdl2_sys::SDL_RegisterEvents

source ·

pub unsafe extern "C" fn SDL_RegisterEvents(
    numevents: c_int
) -> Uint32

Expand description

Allocate a set of user-defined events, and return the beginning event number for that set of events.

Calling this function with numevents <= 0 is an error and will return (Uint32)-1.

Note, (Uint32)-1 means the maximum unsigned 32-bit integer value (or 0xFFFFFFFF), but is clearer to write.

\param numevents the number of events to be allocated \returns the beginning event number, or (Uint32)-1 if there are not enough user-defined events left.

\since This function is available since SDL 2.0.0.

\sa SDL_PushEvent