docs/man3/SDL_AddTimer.3
changeset 55 55f1f1b3e27d
parent 0 74212992fb08
child 181 e5bc29de3f0a
     1.1 --- a/docs/man3/SDL_AddTimer.3	Sun Jun 10 18:39:47 2001 +0000
     1.2 +++ b/docs/man3/SDL_AddTimer.3	Sun Jun 10 19:31:57 2001 +0000
     1.3 @@ -1,4 +1,4 @@
     1.4 -.TH "SDL_AddTimer" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" 
     1.5 +.TH "SDL_AddTimer" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" 
     1.6  .SH "NAME"
     1.7  SDL_AddTimer\- Add a timer which will call a callback after the specified number of milliseconds has elapsed\&.
     1.8  .SH "SYNOPSIS"
     1.9 @@ -19,9 +19,9 @@
    1.10  .PP
    1.11  To cancel a currently running timer call \fISDL_RemoveTimer\fR with the timer ID returned from \fBSDL_AddTimer\fP\&.
    1.12  .PP
    1.13 -The timer callback function may run in a different thread than your main program, and so shouldn\&'t call any functions from within itself\&.
    1.14 +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\&.
    1.15  .PP
    1.16 -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\&.
    1.17 +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\&.
    1.18  .SH "RETURN VALUE"
    1.19  .PP
    1.20  Returns an ID value for the added timer or \fBNULL\fR if there was an error\&.
    1.21 @@ -34,5 +34,5 @@
    1.22  .PP
    1.23  .SH "SEE ALSO"
    1.24  .PP
    1.25 -\fI\fBSDL_RemoveTimer\fP\fR
    1.26 -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04
    1.27 +\fI\fBSDL_RemoveTimer\fP\fR, \fI\fBSDL_PushEvent\fP\fR
    1.28 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41