aboutsummaryrefslogtreecommitdiff
path: root/src/doc/feature/config.dox
blob: ae3a05439cb5d37bb9d0fe3802f18d27ba5760c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// vim:ft=doxygen
namespace crepe {
/**

\defgroup feature_config Engine configuration
\ingroup feature
\brief Configure default values and global options

Default values and options that apply to the engine globally are read from a
singleton struct named Config.

\see Config

\par Example

Configuration options may be set individually or by assigning a [designated
initializer list][desginit]. All of Config's members have default values and can
safely be omitted from initializer lists.

[desginit]: https://en.cppreference.com/w/cpp/language/aggregate_initialization#Designated_initializers

```cpp
#include <crepe/api/Config.h>

int main() {
	auto & config = crepe::Config::get_instance();

	// Designated initializer list
	config = {
		// specify options here
	};

	// Reset default options
	config = {};

	// Set specific option
	config.log.color = false;
}
```

\par Options

\noop Display config properties in monospace font
\htmlonly
<style>
tr td:first-child { font-family: monospace; }
</style>
\endhtmlonly

|Option|Description|
|-|-|
|\ref Config::asset::root_pattern ".asset.root_pattern"|\copybrief Config::asset::root_pattern|
|\ref Config::log::color ".log.color"|\copybrief Config::log::color|
|\ref Config::log::level ".log.level"|\copybrief Config::log::level|
|\ref Config::physics::gravity ".physics.gravity"|\copybrief Config::physics::gravity|
|\ref Config::savemgr::location ".savemgr.location"|\copybrief Config::savemgr::location|
|\ref Config::window_settings::default_size ".window_settings.default_size"|\copybrief Config::window_settings::default_size|
|\ref Config::window_settings::window_title ".window_settings.window_title"|\copybrief Config::window_settings::window_title|

*/
}