Mercurial > sdl-ios-xcode

view docs/man3/SDL_UserEvent.3 @ 907:3bd4d7a1ee04

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Date: Mon, 21 Jun 2004 16:52:47 +0200 From: Marcin Konicki Subject: SDL 1.2.7 patch for BeOS (new input handling code) I rewrote input handling code for BeOS. It should be faster now (i got report that mouse is faster, keyboard should be too, but it's harder to observe). I'll try to add mouse wheel support too, soon. Stefano Ceccherini (a.k.a Jack Burton) helped me beautify code (working version was less clean), and it was he who asked me to write this thing ;).
author Sam Lantinga <slouken@libsdl.org>
date Sun, 18 Jul 2004 19:36:06 +0000
parents e5bc29de3f0a
children 546f7c1eb755
line wrap: on
line source

.TH "SDL_UserEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_UserEvent\- A user-defined event type
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
  Uint8 type;
  int code;
  void *data1;
  void *data2;
} SDL_UserEvent;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBtype\fR
\fBSDL_USEREVENT\fP through to \fBSDL_NUMEVENTS-1\fP
.TP 20
\fBcode\fR
User defined event code
.TP 20
\fBdata1\fR
User defined data pointer
.TP 20
\fBdata2\fR
User defined data pointer
.SH "DESCRIPTION"
.PP
\fBSDL_UserEvent\fR is in the \fBuser\fR member of the structure \fI\fBSDL_Event\fR\fR\&. 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 \fI\fBSDL_PushEvent\fP\fR\&. The contents of the structure members or completely up to the programmer, the only requirement is that \fBtype\fR is a value from \fBSDL_USEREVENT\fP to \fBSDL_NUMEVENTS-1\fP (inclusive)\&.
.SH "EXAMPLES"
.PP
.PP
.nf
\f(CWSDL_Event event;

event\&.type = SDL_USEREVENT;
event\&.user\&.code = my_event_code;
event\&.user\&.data1 = significant_data;
event\&.user\&.data2 = 0;
SDL_PushEvent(&event);\fR
.fi
.PP
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_PushEvent\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00