Pyrogenesis  trunk
ThreadUtil.h
Go to the documentation of this file.
1 /* Copyright (C) 2021 Wildfire Games.
2  * This file is part of 0 A.D.
3  *
4  * 0 A.D. is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * 0 A.D. is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef INCLUDED_THREADUTIL
19 #define INCLUDED_THREADUTIL
20 
21 /**
22  * Light-weight threading utilities.
23  * Implemented in Threading.cpp.
24  * Split from Threading because this is included (via profilers) in most files.
25  */
26 namespace Threading
27 {
28 
29 /**
30  * Returns whether the current thread is the 'main' thread
31  * (i.e. matches an earlier call to SetMainThread).
32  */
33 bool IsMainThread();
34 
35 /**
36  * Set the current thread as the 'main' thread.
37  * (This is called during engine initialisation.)
38  */
39 void SetMainThread();
40 
41 }
42 
43 #endif // INCLUDED_THREADUTIL
void SetMainThread()
Set the current thread as the &#39;main&#39; thread.
Definition: Threading.cpp:37
Light-weight threading utilities.
Definition: TaskManager.cpp:37
bool IsMainThread()
Returns whether the current thread is the &#39;main&#39; thread (i.e.
Definition: Threading.cpp:27