|
slouken@0
|
1 |
.TH "SDL_AddTimer" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference"
|
|
slouken@0
|
2 |
.SH "NAME"
|
|
slouken@0
|
3 |
SDL_AddTimer\- Add a timer which will call a callback after the specified number of milliseconds has elapsed\&.
|
|
slouken@0
|
4 |
.SH "SYNOPSIS"
|
|
slouken@0
|
5 |
.PP
|
|
slouken@0
|
6 |
\fB#include "SDL\&.h"
|
|
slouken@0
|
7 |
.sp
|
|
slouken@0
|
8 |
\fBSDL_TimerID \fBSDL_AddTimer\fP\fR(\fBUint32 interval, SDL_NewTimerCallback callback, void *param\fR);
|
|
slouken@0
|
9 |
.SH "CALLBACK"
|
|
slouken@0
|
10 |
.PP
|
|
slouken@0
|
11 |
.nf
|
|
slouken@0
|
12 |
\f(CW/* type definition for the "new" timer callback function */
|
|
slouken@0
|
13 |
typedef Uint32 (*SDL_NewTimerCallback)(Uint32 interval, void *param);\fR
|
|
slouken@0
|
14 |
.fi
|
|
slouken@0
|
15 |
.PP
|
|
slouken@0
|
16 |
.SH "DESCRIPTION"
|
|
slouken@0
|
17 |
.PP
|
|
slouken@0
|
18 |
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\&.
|
|
slouken@0
|
19 |
.PP
|
|
slouken@0
|
20 |
To cancel a currently running timer call \fISDL_RemoveTimer\fR with the timer ID returned from \fBSDL_AddTimer\fP\&.
|
|
slouken@0
|
21 |
.PP
|
|
slouken@0
|
22 |
The timer callback function may run in a different thread than your main program, and so shouldn\&'t call any functions from within itself\&.
|
|
slouken@0
|
23 |
.PP
|
|
slouken@0
|
24 |
The maximum resolution of this timer is 10 ms, which 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\&.
|
|
slouken@0
|
25 |
.SH "RETURN VALUE"
|
|
slouken@0
|
26 |
.PP
|
|
slouken@0
|
27 |
Returns an ID value for the added timer or \fBNULL\fR if there was an error\&.
|
|
slouken@0
|
28 |
.SH "EXAMPLES"
|
|
slouken@0
|
29 |
.PP
|
|
slouken@0
|
30 |
.PP
|
|
slouken@0
|
31 |
.nf
|
|
slouken@0
|
32 |
\f(CWmy_timer_id = SDL_AddTimer((33/10)*10, my_callbackfunc, my_callback_param);\fR
|
|
slouken@0
|
33 |
.fi
|
|
slouken@0
|
34 |
.PP
|
|
slouken@0
|
35 |
.SH "SEE ALSO"
|
|
slouken@0
|
36 |
.PP
|
|
slouken@0
|
37 |
\fI\fBSDL_RemoveTimer\fP\fR
|
|
slouken@0
|
38 |
...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04
|