Codefix: Documentation comment in IndustryDirectoryWindow (#13059)
[openttd-github.git] / src / zoom_type.h
blob89c812b06a4c6e74a95f897dd14976b8078c7545
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
8 /** @file zoom_type.h Types related to zooming in and out. */
10 #ifndef ZOOM_TYPE_H
11 #define ZOOM_TYPE_H
13 #include "core/enum_type.hpp"
15 /** All zoom levels we know. */
16 enum ZoomLevel : uint8_t {
17 /* Our possible zoom-levels */
18 ZOOM_LVL_BEGIN = 0, ///< Begin for iteration.
19 ZOOM_LVL_IN_4X = 0, ///< Zoomed 4 times in.
20 ZOOM_LVL_IN_2X, ///< Zoomed 2 times in.
21 ZOOM_LVL_NORMAL, ///< The normal zoom level.
22 ZOOM_LVL_OUT_2X, ///< Zoomed 2 times out.
23 ZOOM_LVL_OUT_4X, ///< Zoomed 4 times out.
24 ZOOM_LVL_OUT_8X, ///< Zoomed 8 times out.
25 ZOOM_LVL_END, ///< End for iteration.
27 /* Here we define in which zoom viewports are */
28 ZOOM_LVL_VIEWPORT = ZOOM_LVL_NORMAL, ///< Default zoom level for viewports.
29 ZOOM_LVL_NEWS = ZOOM_LVL_NORMAL, ///< Default zoom level for the news messages.
30 ZOOM_LVL_INDUSTRY = ZOOM_LVL_OUT_2X, ///< Default zoom level for the industry view.
31 ZOOM_LVL_TOWN = ZOOM_LVL_NORMAL, ///< Default zoom level for the town view.
32 ZOOM_LVL_AIRCRAFT = ZOOM_LVL_NORMAL, ///< Default zoom level for the aircraft view.
33 ZOOM_LVL_SHIP = ZOOM_LVL_NORMAL, ///< Default zoom level for the ship view.
34 ZOOM_LVL_TRAIN = ZOOM_LVL_NORMAL, ///< Default zoom level for the train view.
35 ZOOM_LVL_ROADVEH = ZOOM_LVL_NORMAL, ///< Default zoom level for the road vehicle view.
36 ZOOM_LVL_WORLD_SCREENSHOT = ZOOM_LVL_NORMAL, ///< Default zoom level for the world screen shot.
38 ZOOM_LVL_DETAIL = ZOOM_LVL_OUT_2X, ///< All zoom levels below or equal to this will result in details on the screen, like road-work, ...
39 ZOOM_LVL_TEXT_EFFECT = ZOOM_LVL_OUT_2X, ///< All zoom levels above this will not show text effects.
41 ZOOM_LVL_MIN = ZOOM_LVL_IN_4X, ///< Minimum zoom level.
42 ZOOM_LVL_MAX = ZOOM_LVL_OUT_8X, ///< Maximum zoom level.
44 DECLARE_POSTFIX_INCREMENT(ZoomLevel)
45 DECLARE_ENUM_AS_ADDABLE(ZoomLevel)
47 static uint const ZOOM_BASE_SHIFT = static_cast<uint>(ZOOM_LVL_NORMAL);
48 static uint const ZOOM_BASE = 1U << ZOOM_BASE_SHIFT;
50 extern int _gui_scale;
51 extern int _gui_scale_cfg;
53 extern ZoomLevel _gui_zoom;
54 extern ZoomLevel _font_zoom;
55 #define ZOOM_LVL_GUI (_gui_zoom)
57 static const int MIN_INTERFACE_SCALE = 100;
58 static const int MAX_INTERFACE_SCALE = 500;
60 #endif /* ZOOM_TYPE_H */