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
24 extern unsigned int st_pause_ticks, st_pause_count;
26 /// Time a game is running. (Non-pause mode, etc.)
27 unsigned int st_get_ticks(void);
29 void st_pause_ticks_init(void);
30 void st_pause_ticks_start(void);
31 void st_pause_ticks_stop(void);
32 bool st_pause_ticks_started(void);
35 /** This class can be used as stop watch
36 for example. It's also possible to calculate
37 frames per seconds and things like that with it.
38 It's a general timing class, but it
39 can esspecially be used together with st_get_ticks(). */
45 unsigned int (*get_ticks) (void);
50 /// Initialize the timer.
51 /** @Param st_ticks: If true internally st_get_ticks() is used, else SDL_GetTicks() is used. */
52 void init(bool st_ticks);
54 /// Start the timer with the given period (in ms).
55 void start(unsigned int period);
60 /// Check if the timer is started and within its period.
61 /** If one of these requirements isn't the case the timer
62 is automatically reseted. */
65 /// Is the timer started?
68 /// Get time left until the last timing period is finished.
69 /** The returned value can be negative. */
72 /// Get the gone time, since last timer start.
73 /** The returned value can be negative. */
76 /// Write the timer value to a file (For save games in example).
77 void fwrite(FILE* fi);
78 /// Read a timer value from a file (From save games in example).
82 #endif /*SUPERTUX_TIMER_H*/
84 /* Local Variables: */