Codechange: be consistent in naming the paint function Paint()
[openttd-github.git] / src / zoom_type.h
blob0945e1cc0960ff8b17120a3a2ce36a23dec2ce3c
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 static uint const ZOOM_LVL_SHIFT = 2;
16 static uint const ZOOM_LVL_BASE = 1 << ZOOM_LVL_SHIFT;
18 static const int8 ZOOM_LVL_CFG_AUTO = -1;
20 /** All zoom levels we know. */
21 enum ZoomLevel : byte {
22 /* Our possible zoom-levels */
23 ZOOM_LVL_BEGIN = 0, ///< Begin for iteration.
24 ZOOM_LVL_NORMAL = 0, ///< The normal zoom level.
25 ZOOM_LVL_OUT_2X, ///< Zoomed 2 times out.
26 ZOOM_LVL_OUT_4X, ///< Zoomed 4 times out.
27 ZOOM_LVL_OUT_8X, ///< Zoomed 8 times out.
28 ZOOM_LVL_OUT_16X, ///< Zoomed 16 times out.
29 ZOOM_LVL_OUT_32X, ///< Zoomed 32 times out.
30 ZOOM_LVL_END, ///< End for iteration.
32 ZOOM_LVL_COUNT = ZOOM_LVL_END - ZOOM_LVL_BEGIN, ///< Number of zoom levels.
34 /* Here we define in which zoom viewports are */
35 ZOOM_LVL_VIEWPORT = ZOOM_LVL_OUT_4X, ///< Default zoom level for viewports.
36 ZOOM_LVL_NEWS = ZOOM_LVL_OUT_4X, ///< Default zoom level for the news messages.
37 ZOOM_LVL_INDUSTRY = ZOOM_LVL_OUT_8X, ///< Default zoom level for the industry view.
38 ZOOM_LVL_TOWN = ZOOM_LVL_OUT_8X, ///< Default zoom level for the town view.
39 ZOOM_LVL_AIRCRAFT = ZOOM_LVL_OUT_4X, ///< Default zoom level for the aircraft view.
40 ZOOM_LVL_SHIP = ZOOM_LVL_OUT_4X, ///< Default zoom level for the ship view.
41 ZOOM_LVL_TRAIN = ZOOM_LVL_OUT_4X, ///< Default zoom level for the train view.
42 ZOOM_LVL_ROADVEH = ZOOM_LVL_OUT_4X, ///< Default zoom level for the road vehicle view.
43 ZOOM_LVL_WORLD_SCREENSHOT = ZOOM_LVL_OUT_4X, ///< Default zoom level for the world screen shot.
45 ZOOM_LVL_DETAIL = ZOOM_LVL_OUT_8X, ///< All zoomlevels below or equal to this, will result in details on the screen, like road-work, ...
47 ZOOM_LVL_MIN = ZOOM_LVL_NORMAL, ///< Minimum zoom level.
48 ZOOM_LVL_MAX = ZOOM_LVL_OUT_32X, ///< Maximum zoom level.
51 DECLARE_POSTFIX_INCREMENT(ZoomLevel)
53 extern int8 _gui_zoom_cfg;
54 extern int8 _font_zoom_cfg;
56 extern ZoomLevel _gui_zoom;
57 extern ZoomLevel _font_zoom;
58 #define ZOOM_LVL_GUI (_gui_zoom)
59 #define ZOOM_LVL_FONT (_font_zoom)
61 #endif /* ZOOM_TYPE_H */