libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2024-12-05 00:36:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

added doxygen comment

Browse Source 
svn-id: r11036
This commit is contained in:
Max Horn 2003-11-01 21:23:48 +00:00
parent 561d4c09d8
commit adbaab7ef9
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
common/timer.h
View File

@ -52,8 +52,24 @@ public:
Timer(OSystem *system);
~Timer();
bool installTimerProc(TimerProc procedure, int32 interval, void *refCon);
void removeTimerProc(TimerProc procedure);
/**
* Install a new timer callback. It will from now be called every interval microseconds.
* The timer may be invoked from a seperate thread. Hence any timer code should be
* written following the same safety guidelines as any other threaded code.
*
* @note Although the interval is specified in microseconds, the actual timer resolution
* may be lower. In particular, with the SDL backend the timer resolution is 10ms.
* @param proc the callback
* @param interval the interval in which the timer shall be invoked (in microseconds)
* @param refCon an arbitrary void pointer; will be passed to the timer callback
* @return true if the timer was installed successfully, false otherwise
*/
bool installTimerProc(TimerProc proc, int32 interval, void *refCon);
/**
* Remove the given timer callback. It will not be invoked anymore.
*/
void removeTimerProc(TimerProc proc);
protected:
static int timer_handler(int t);