Tao.Sdl SDK Documentation

Sdl.SDL_UserEvent Structure

A user-defined event type

For a list of all members of this type, see Sdl.SDL_UserEvent Members.

System.Object
   System.ValueType
      Tao.Sdl.Sdl.SDL_UserEvent

[Visual Basic]
Public Structure Sdl.SDL_UserEvent
[C#]
public struct Sdl.SDL_UserEvent

Thread Safety

Public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

Remarks

SDL_UserEvent is in the user member of the structure Sdl.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).

Struct in SDL_events.h

            typedef struct{
                    Uint8 type;
                    int code;
                    void *data1;
                    void *data2;
                } SDL_UserEvent;
            

Example

            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);
            

Requirements

Namespace: Tao.Sdl

Assembly: Tao.Sdl (in Tao.Sdl.dll)

See Also

Sdl.SDL_UserEvent Members | Tao.Sdl Namespace | Sdl.SDL_Event | SDL_PushEvent