4 // Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License
8 // as published by the Free Software Foundation; either version 2
9 // of the License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
21 #ifndef SUPERTUX_TIMER_H
22 #define SUPERTUX_TIMER_H
30 /// Time a game is running. (Non-pause mode, etc.)
31 static unsigned int get(void);
33 static void pause_init(void);
34 static void pause_start(void);
35 static void pause_stop(void);
36 static bool pause_started(void);
39 static unsigned int pause_ticks;
40 static unsigned int pause_count;
45 /** This class can be used as stop watch
46 for example. It's also possible to calculate
47 frames per seconds and things like that with it.
48 It's a general timing class, but it
49 can esspecially be used together with Ticks::get(). */
55 unsigned int (*get_ticks) (void);
60 /// Initialize the timer.
61 /** @param st_ticks: If true internally Ticks::get() is used, else SDL_GetTicks() is used. */
62 void init(bool game_ticks);
64 /// Start the timer with the given period (in ms).
65 void start(unsigned int period);
70 /// Check if the timer is started and within its period.
71 /** If one of these requirements isn't the case the timer
72 is automatically reseted. */
75 /// Is the timer started?
78 /// Get time left until the last timing period is finished.
79 /** The returned value can be negative. */
82 /// Get the gone time, since last timer start.
83 /** The returned value can be negative. */
86 /// Write the timer value to a file (For save games in example).
87 void fwrite(FILE* fi);
88 /// Read a timer value from a file (From save games in example).
92 } //namespace SuperTux
94 #endif /*SUPERTUX_TIMER_H*/
96 /* Local Variables: */