scummvm/timer.h
Pawel Kolodziejski adbb36cf8b added timer code
2003-12-12 21:38:12 +00:00

75 lines
2.2 KiB
C++

// Residual - Virtual machine to run LucasArts' 3D adventure games
// Copyright (C) 2003 The ScummVM-Residual Team (www.scummvm.org)
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#ifndef COMMON_TIMER_H
#define COMMON_TIMER_H
#include "stdafx.h"
#include "bits.h"
#define MAX_TIMERS 3
typedef void (*TimerProc)(void *refCon);
class Timer {
private:
MutexRef _mutex;
void *_timerHandler;
int32 _thisTime;
int32 _lastTime;
struct TimerSlots {
TimerProc procedure;
int32 interval;
int32 counter;
void *refCon;
} _timerSlots[MAX_TIMERS];
public:
Timer();
~Timer();
/**
* Install a new timer callback. It will from now be called every interval microseconds.
* The timer may be invoked from a separate 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);
int handler(int t);
};
extern Timer *g_timer;
#endif