Mercurial > sdl-ios-xcode
diff docs/man3/SDL_AddTimer.3 @ 55:55f1f1b3e27d
Added new docs for SDL 1.2.1
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Sun, 10 Jun 2001 19:31:57 +0000 |
parents | 74212992fb08 |
children | e5bc29de3f0a |
line wrap: on
line diff
--- a/docs/man3/SDL_AddTimer.3 Sun Jun 10 18:39:47 2001 +0000 +++ b/docs/man3/SDL_AddTimer.3 Sun Jun 10 19:31:57 2001 +0000 @@ -1,4 +1,4 @@ -.TH "SDL_AddTimer" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_AddTimer" "3" "Sun 10 Jun 2001, 19:41" "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" @@ -19,9 +19,9 @@ .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\&. +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 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\&. +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\&. @@ -34,5 +34,5 @@ .PP .SH "SEE ALSO" .PP -\fI\fBSDL_RemoveTimer\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +\fI\fBSDL_RemoveTimer\fP\fR, \fI\fBSDL_PushEvent\fP\fR +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41