ScummVM API documentation
config.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef AGS_ENGINE_MAIN_CONFIG_H
23#define AGS_ENGINE_MAIN_CONFIG_H
24
25#include "ags/engine/main/graphics_mode.h"
26#include "ags/shared/util/ini_util.h"
27
28namespace AGS3 {
29
30using AGS::Shared::String;
31using AGS::Shared::ConfigTree;
32
33// Set up default config settings
34void config_defaults();
35// Find and default configuration file (usually located in the game installation directory)
36String find_default_cfg_file();
37// Find all-games user configuration file
38String find_user_global_cfg_file();
39// Find and game-specific user configuration file (located into writable user directory)
40String find_user_cfg_file();
41// Apply overriding values from the external config (e.g. for mobile ports)
42void override_config_ext(ConfigTree &cfg);
43// Setup game using final config tree
44void apply_config(const ConfigTree &cfg);
45// Fixup game setup parameters
46void post_config();
47
48void save_config_file();
49
50FrameScaleDef parse_scaling_option(const String &option, FrameScaleDef def_value = kFrame_Undefined);
51String make_scaling_option(FrameScaleDef scale_def);
52uint32_t convert_scaling_to_fp(int scale_factor);
53int convert_fp_to_scaling(uint32_t scaling);
54
55} // namespace AGS3
56
57#endif