src/zoom_func.h

   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  */
   7
   8 /** @file zoom_func.h Functions related to zooming. */
   9
  10 #ifndef ZOOM_FUNC_H
  11 #define ZOOM_FUNC_H
  12
  13 #include "zoom_type.h"
  14
  15 /**
  16  * Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL)
  17  * When shifting right, value is rounded up
  18  * @param value value to shift
  19  * @param zoom  zoom level to shift to
  20  * @return shifted value
  21  */
  22 static inline int ScaleByZoom(int value, ZoomLevel zoom)
  23 {
  24         return value << zoom;
  25 }
  26
  27 /**
  28  * Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
  29  * When shifting right, value is rounded up
  30  * @param value value to shift
  31  * @param zoom  zoom level to shift to
  32  * @return shifted value
  33  */
  34 static inline int UnScaleByZoom(int value, ZoomLevel zoom)
  35 {
  36         return (value + (1 << zoom) - 1) >> zoom;
  37 }
  38
  39 /**
  40  * Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL)
  41  * @param value value to shift
  42  * @param zoom  zoom level to shift to
  43  * @return shifted value
  44  */
  45 static inline int ScaleByZoomLower(int value, ZoomLevel zoom)
  46 {
  47         return value << zoom;
  48 }
  49
  50 /**
  51  * Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
  52  * @param value value to shift
  53  * @param zoom  zoom level to shift to
  54  * @return shifted value
  55  */
  56 static inline int UnScaleByZoomLower(int value, ZoomLevel zoom)
  57 {
  58         return value >> zoom;
  59 }
  60
  61 /**
  62  * Short-hand to apply GUI zoom level.
  63  * @param value Pixel amount at #ZOOM_LVL_BEGIN (full zoom in).
  64  * @return Pixel amount at #ZOOM_LVL_GUI (current interface size).
  65  */
  66 static inline int UnScaleGUI(int value)
  67 {
  68         return UnScaleByZoom(value, ZOOM_LVL_GUI);
  69 }
  70
  71 /**
  72  * Scale traditional pixel dimensions to GUI zoom level.
  73  * @param value Pixel amount at #ZOOM_LVL_BASE (traditional "normal" interface size).
  74  * @return Pixel amount at #ZOOM_LVL_GUI (current interface size).
  75  */
  76 static inline int ScaleGUITrad(int value)
  77 {
  78         return UnScaleGUI(value * ZOOM_LVL_BASE);
  79 }
  80
  81 /**
  82  * Short-hand to apply font zoom level.
  83  * @param value Pixel amount at #ZOOM_LVL_BEGIN (full zoom in).
  84  * @return Pixel amount at #ZOOM_LVL_FONT (current interface size).
  85  */
  86 static inline int UnScaleFont(int value)
  87 {
  88         return UnScaleByZoom(value, ZOOM_LVL_FONT);
  89 }
  90
  91 /**
  92  * Scale traditional pixel dimensions to Font zoom level.
  93  * @param value Pixel amount at #ZOOM_LVL_BASE (traditional "normal" interface size).
  94  * @return Pixel amount at #ZOOM_LVL_FONT (current interface size).
  95  */
  96 static inline int ScaleFontTrad(int value)
  97 {
  98         return UnScaleFont(value * ZOOM_LVL_BASE);
  99 }
 100
 101 #endif /* ZOOM_FUNC_H */