Mercurial > sdl-ios-xcode
annotate include/SDL_timer.h @ 4231:2d5c44f1be14 SDL-1.2
Added missing newline
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Tue, 22 Sep 2009 02:37:30 +0000 |
| parents | 4c4113c2162c |
| children |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 4159 | 3 Copyright (C) 1997-2009 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1028
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1028
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 9 |
| 10 This library is distributed in the hope that it will be useful, | |
| 11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1028
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1028
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1028
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1028
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 23 #ifndef _SDL_timer_h | |
| 24 #define _SDL_timer_h | |
| 25 | |
| 4217 | 26 /** @file SDL_timer.h |
| 27 * Header for the SDL time management routines | |
| 28 */ | |
| 0 | 29 |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
30 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
31 #include "SDL_error.h" |
| 0 | 32 |
| 33 #include "begin_code.h" | |
| 34 /* Set up for C function definitions, even when using C++ */ | |
| 35 #ifdef __cplusplus | |
| 36 extern "C" { | |
| 37 #endif | |
| 38 | |
| 4217 | 39 /** This is the OS scheduler timeslice, in milliseconds */ |
| 0 | 40 #define SDL_TIMESLICE 10 |
| 41 | |
| 4217 | 42 /** This is the maximum resolution of the SDL timer on all platforms */ |
| 43 #define TIMER_RESOLUTION 10 /**< Experimentally determined */ | |
| 0 | 44 |
| 4217 | 45 /** |
| 46 * Get the number of milliseconds since the SDL library initialization. | |
| 0 | 47 * Note that this value wraps if the program runs for more than ~49 days. |
| 48 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
49 extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void); |
| 0 | 50 |
| 4217 | 51 /** Wait a specified number of milliseconds before returning */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
52 extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms); |
| 0 | 53 |
| 4217 | 54 /** Function prototype for the timer callback function */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
55 typedef Uint32 (SDLCALL *SDL_TimerCallback)(Uint32 interval); |
| 0 | 56 |
| 4217 | 57 /** |
| 58 * Set a callback to run after the specified number of milliseconds has | |
| 0 | 59 * elapsed. The callback function is passed the current timer interval |
| 60 * and returns the next timer interval. If the returned value is the | |
| 61 * same as the one passed in, the periodic alarm continues, otherwise a | |
| 62 * new alarm is scheduled. If the callback returns 0, the periodic alarm | |
| 63 * is cancelled. | |
| 64 * | |
| 65 * To cancel a currently running timer, call SDL_SetTimer(0, NULL); | |
| 66 * | |
| 67 * The timer callback function may run in a different thread than your | |
| 68 * main code, and so shouldn't call any functions from within itself. | |
| 69 * | |
| 70 * The maximum resolution of this timer is 10 ms, which means that if | |
| 71 * you request a 16 ms timer, your callback will run approximately 20 ms | |
| 72 * later on an unloaded system. If you wanted to set a flag signaling | |
| 73 * a frame update at 30 frames per second (every 33 ms), you might set a | |
| 74 * timer for 30 ms: | |
| 4217 | 75 * @code SDL_SetTimer((33/10)*10, flag_update); @endcode |
| 0 | 76 * |
| 77 * If you use this function, you need to pass SDL_INIT_TIMER to SDL_Init(). | |
| 78 * | |
| 79 * Under UNIX, you should not use raise or use SIGALRM and this function | |
| 80 * in the same program, as it is implemented using setitimer(). You also | |
| 81 * should not use this function in multi-threaded applications as signals | |
| 82 * to multi-threaded apps have undefined behavior in some implementations. | |
|
1028
5ba65305c954
Fix various problems with the timer code.
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
83 * |
|
5ba65305c954
Fix various problems with the timer code.
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
84 * This function returns 0 if successful, or -1 if there was an error. |
| 0 | 85 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
86 extern DECLSPEC int SDLCALL SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback); |
| 0 | 87 |
| 4217 | 88 /** @name New timer API |
| 89 * New timer API, supports multiple timers | |
| 0 | 90 * Written by Stephane Peter <megastep@lokigames.com> |
| 91 */ | |
| 4217 | 92 /*@{*/ |
| 0 | 93 |
| 4217 | 94 /** |
| 95 * Function prototype for the new timer callback function. | |
| 0 | 96 * The callback function is passed the current timer interval and returns |
| 97 * the next timer interval. If the returned value is the same as the one | |
| 98 * passed in, the periodic alarm continues, otherwise a new alarm is | |
| 99 * scheduled. If the callback returns 0, the periodic alarm is cancelled. | |
| 100 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
101 typedef Uint32 (SDLCALL *SDL_NewTimerCallback)(Uint32 interval, void *param); |
| 0 | 102 |
| 4217 | 103 /** Definition of the timer ID type */ |
| 0 | 104 typedef struct _SDL_TimerID *SDL_TimerID; |
| 105 | |
| 4217 | 106 /** Add a new timer to the pool of timers already running. |
| 107 * Returns a timer ID, or NULL when an error occurs. | |
| 0 | 108 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
109 extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_NewTimerCallback callback, void *param); |
| 0 | 110 |
| 4217 | 111 /** |
| 112 * Remove one of the multiple timers knowing its ID. | |
| 0 | 113 * Returns a boolean value indicating success. |
| 114 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
115 extern DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID t); |
| 0 | 116 |
| 4217 | 117 /*@}*/ |
| 118 | |
| 0 | 119 /* Ends C function definitions when using C++ */ |
| 120 #ifdef __cplusplus | |
| 121 } | |
| 122 #endif | |
| 123 #include "close_code.h" | |
| 124 | |
| 125 #endif /* _SDL_timer_h */ |