TSDL_UserEvent

Name

TSDL_UserEvent -- A user-defined event type

Structure Definition

  TSDL_UserEvent = record
type_: UInt8; // SDL_USEREVENT through SDL_NUMEVENTS-1
code: Integer; // User defined event code */
data1: Pointer; // User defined data pointer */
data2: Pointer; // User defined data pointer */
end;

Structure Data

type SDL_USEREVENT through to SDL_NUMEVENTS-1
code User defined event code
data1 User defined data pointer
data2 User defined data pointer

Description

TSDL_UserEvent is in the user member of the structure TSDL_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

event : TSDL_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

TSDL_Event , SDL_PushEvent