Mercurial > sdl-ios-xcode
view docs/man3/SDL_AddTimer.3 @ 897:9e27fdb98eab
Date: Tue, 11 May 2004 22:05:32 -0400
From: Bob Ippolito
Subject: [SDL] SDL_QuartzWM patches
I've sent in two small patches to SDL_QuartzWM directly to Sam over the
past few months (well, I think I sent both anyway) and neither of them
have been implemented. I didn't receive a response, so I'm sure he was
just busy and/or they got lost, so I decided to sign up to the list and
post them here.
This patch rolls both of them together:
- Mouse cursor becomes visible if hidden when it moves outside of the
game window. If you want it to stay invisible you should warp it
because if it's not warped a user might click some random other
application! Commercial games behave in this way (or at least Warcraft
III does, which is the only one that uses a custom mouse cursor and no
warping that I've played in recent memory).
- Right mouse button emulation is changed from Command-Click to
Control-Click, which is how OS X behaves.
Consider copyright assigned to whomever needs it under whichever
license it needs to be under.. yadda yadda yadda.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Mon, 17 May 2004 00:16:24 +0000 |
| parents | e5bc29de3f0a |
| children | 546f7c1eb755 |
line wrap: on
line source
.TH "SDL_AddTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_AddTimer\- Add a timer which will call a callback after the specified number of milliseconds has elapsed\&. .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBSDL_TimerID \fBSDL_AddTimer\fP\fR(\fBUint32 interval, SDL_NewTimerCallback callback, void *param\fR); .SH "CALLBACK" .PP .nf \f(CW/* type definition for the "new" timer callback function */ typedef Uint32 (*SDL_NewTimerCallback)(Uint32 interval, void *param);\fR .fi .PP .SH "DESCRIPTION" .PP Adds a callback function to be run after the specified number of milliseconds has elapsed\&. The callback function is passed the current timer interval and the user supplied parameter from the \fBSDL_AddTimer\fP call and returns the next timer interval\&. If the returned value from the callback is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled\&. .PP To cancel a currently running timer call \fISDL_RemoveTimer\fR with the timer ID returned from \fBSDL_AddTimer\fP\&. .PP The timer callback function may run in a different thread than your main program, and so shouldn\&'t call any functions from within itself\&. You may always call \fISDL_PushEvent\fR, however\&. .PP The granularity of the timer is platform-dependent, but you should count on it being at least 10 ms as this is the most common number\&. This means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system\&. If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms (see example below)\&. If you use this function, you need to pass \fBSDL_INIT_TIMER\fP to \fISDL_Init\fR\&. .SH "RETURN VALUE" .PP Returns an ID value for the added timer or \fBNULL\fR if there was an error\&. .SH "EXAMPLES" .PP .PP .nf \f(CWmy_timer_id = SDL_AddTimer((33/10)*10, my_callbackfunc, my_callback_param);\fR .fi .PP .SH "SEE ALSO" .PP \fI\fBSDL_RemoveTimer\fP\fR, \fI\fBSDL_PushEvent\fP\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01