(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / progress.h
blobeec369b23c232c7ce859062c0c91c4080a7eb9e4
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file progress.h Functions related to modal progress. */
12 #ifndef PROGRESS_H
13 #define PROGRESS_H
15 #include "thread/thread.h"
17 static const uint MODAL_PROGRESS_REDRAW_TIMEOUT = 200; ///< Timeout between redraws
19 /**
20 * Check if we are currently in a modal progress state.
21 * @return Are we in the modal state?
23 static inline bool HasModalProgress()
25 extern bool _in_modal_progress;
26 return _in_modal_progress;
29 bool IsFirstModalProgressLoop();
30 void SetModalProgress(bool state);
32 extern class ThreadMutex *_modal_progress_work_mutex;
33 extern class ThreadMutex *_modal_progress_paint_mutex;
35 #endif /* PROGRESS_H */