diff options
author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-15 20:26:26 +0100 |
---|---|---|
committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-15 20:26:26 +0100 |
commit | 5bee4515c1089ce3499bc3b74780db94f0c02306 (patch) | |
tree | 3e18158665e45851b92c61095664fc16060c8fd2 /src/crepe/api/Config.h | |
parent | 8600b8a29351aae26ec7b22f84aeeef92d8cb421 (diff) |
process feedback on #26
Diffstat (limited to 'src/crepe/api/Config.h')
-rw-r--r-- | src/crepe/api/Config.h | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/src/crepe/api/Config.h b/src/crepe/api/Config.h index e3f86bf..92b20b7 100644 --- a/src/crepe/api/Config.h +++ b/src/crepe/api/Config.h @@ -4,16 +4,21 @@ namespace crepe { +/** + * \brief Global configuration interface + * + * This class stores engine default settings. Properties on this class are only + * supposed to be modified *before* execution is handed over from the game + * programmer to the engine (i.e. the main loop is started). + */ class Config { -private: - Config() = default; - -public: - ~Config() = default; - public: //! Retrieve handle to global Config instance static Config & get_instance(); + +private: + Config() = default; + // singleton Config(const Config &) = delete; Config(Config &&) = delete; |