Leahnaya/SDL
1
0
Fork 0
mirror of https://github.com/yawut/SDL.git synced 2026-09-10 01:56:15 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added new docs for SDL 1.2.1

Browse Source
This commit is contained in:
Sam Lantinga
2001-06-10 19:31:57 +00:00
parent c5e72a0226
commit e6f1bd6af5
371 changed files with 3272 additions and 2287 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/man3/SDL_AddTimer.3
View File

@@ -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 @@ Adds a callback function to be run after the specified number of milliseconds ha
.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 @@ Returns an ID value for the added timer or \fBNULL\fR if there was an error\&.
.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