src/gfx_func.h

   1 /* $Id: gfx_func.h 26217 2014-01-03 08:51:49Z rubidium $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file gfx_func.h Functions related to the gfx engine. */
  11
  12 /**
  13  * @defgroup dirty Dirty
  14  *
  15  * Handles the repaint of some part of the screen.
  16  *
  17  * Some places in the code are called functions which makes something "dirty".
  18  * This has nothing to do with making a Tile or Window darker or less visible.
  19  * This term comes from memory caching and is used to define an object must
  20  * be repaint. If some data of an object (like a Tile, Window, Vehicle, whatever)
  21  * are changed which are so extensive the object must be repaint its marked
  22  * as "dirty". The video driver repaint this object instead of the whole screen
  23  * (this is btw. also possible if needed). This is used to avoid a
  24  * flickering of the screen by the video driver constantly repainting it.
  25  *
  26  * This whole mechanism is controlled by an rectangle defined in #_invalid_rect. This
  27  * rectangle defines the area on the screen which must be repaint. If a new object
  28  * needs to be repainted this rectangle is extended to 'catch' the object on the
  29  * screen. At some point (which is normally uninteresting for patch writers) this
  30  * rectangle is send to the video drivers method
  31  * VideoDriver::MakeDirty and it is truncated back to an empty rectangle. At some
  32  * later point (which is uninteresting, too) the video driver
  33  * repaints all these saved rectangle instead of the whole screen and drop the
  34  * rectangle informations. Then a new round begins by marking objects "dirty".
  35  *
  36  * @see VideoDriver::MakeDirty
  37  * @see _invalid_rect
  38  * @see _screen
  39  */
  40
  41
  42 #ifndef GFX_FUNC_H
  43 #define GFX_FUNC_H
  44
  45 #include "gfx_type.h"
  46 #include "strings_type.h"
  47 #include "string_type.h"
  48
  49 void GameLoop();
  50
  51 void CreateConsole();
  52
  53 extern byte _dirkeys;        ///< 1 = left, 2 = up, 4 = right, 8 = down
  54 extern bool _fullscreen;
  55 extern byte _support8bpp;
  56 extern CursorVars _cursor;
  57 extern bool _ctrl_pressed;   ///< Is Ctrl pressed?
  58 extern bool _shift_pressed;  ///< Is Shift pressed?
  59 extern byte _fast_forward;
  60
  61 extern bool _left_button_down;
  62 extern bool _left_button_clicked;
  63 extern bool _right_button_down;
  64 extern bool _right_button_clicked;
  65
  66 extern DrawPixelInfo _screen;
  67 extern bool _screen_disable_anim;   ///< Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
  68
  69 extern int _num_resolutions;
  70 extern Dimension _resolutions[32];
  71 extern Dimension _cur_resolution;
  72 extern Palette _cur_palette; ///< Current palette
  73
  74 void HandleKeypress(uint keycode, WChar key);
  75 void HandleTextInput(const char *str, bool marked = false, const char *caret = nullptr, const char *insert_location = nullptr, const char *replacement_end = nullptr);
  76 void HandleCtrlChanged();
  77 void HandleMouseEvents();
  78 void CSleep(int milliseconds);
  79 void UpdateWindows();
  80
  81 void DrawMouseCursor();
  82 void ScreenSizeChanged();
  83 void GameSizeChanged();
  84 void UndrawMouseCursor();
  85
  86 /** Size of the buffer used for drawing strings. */
  87 static const int DRAW_STRING_BUFFER = 2048;
  88
  89 void RedrawScreenRect(int left, int top, int right, int bottom);
  90 void GfxScroll(int left, int top, int width, int height, int xo, int yo);
  91
  92 Dimension GetSpriteSize(SpriteID sprid, Point *offset = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
  93 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr);
  94 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
  95
  96 /** How to align the to-be drawn text. */
  97 enum StringAlignment {
  98         SA_LEFT        = 0 << 0, ///< Left align the text.
  99         SA_HOR_CENTER  = 1 << 0, ///< Horizontally center the text.
 100         SA_RIGHT       = 2 << 0, ///< Right align the text (must be a single bit).
 101         SA_HOR_MASK    = 3 << 0, ///< Mask for horizontal alignment.
 102
 103         SA_TOP         = 0 << 2, ///< Top align the text.
 104         SA_VERT_CENTER = 1 << 2, ///< Vertically center the text.
 105         SA_BOTTOM      = 2 << 2, ///< Bottom align the text.
 106         SA_VERT_MASK   = 3 << 2, ///< Mask for vertical alignment.
 107
 108         SA_CENTER      = SA_HOR_CENTER | SA_VERT_CENTER, ///< Center both horizontally and vertically.
 109
 110         SA_FORCE       = 1 << 4, ///< Force the alignment, i.e. don't swap for RTL languages.
 111 };
 112 DECLARE_ENUM_AS_BIT_SET(StringAlignment)
 113
 114 int DrawString(int left, int right, int top, const char *str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL);
 115 int DrawString(int left, int right, int top, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL);
 116 int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL);
 117 int DrawStringMultiLine(int left, int right, int top, int bottom, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL);
 118
 119 void DrawCharCentered(uint32 c, int x, int y, TextColour colour);
 120
 121 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode = FILLRECT_OPAQUE);
 122 void GfxDrawLine(int left, int top, int right, int bottom, int colour, int width = 1, int dash = 0);
 123 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3);
 124
 125 Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize = FS_NORMAL);
 126 Dimension GetStringBoundingBox(StringID strid);
 127 int GetStringHeight(const char *str, int maxw, FontSize fontsize = FS_NORMAL);
 128 int GetStringHeight(StringID str, int maxw);
 129 int GetStringLineCount(StringID str, int maxw);
 130 Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion);
 131 Dimension GetStringMultiLineBoundingBox(const char *str, const Dimension &suggestion);
 132 void LoadStringWidthTable(bool monospace = false);
 133 Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize = FS_NORMAL);
 134 const char *GetCharAtPosition(const char *str, int x, FontSize start_fontsize = FS_NORMAL);
 135
 136 void DrawDirtyBlocks();
 137 void SetDirtyBlocks(int left, int top, int right, int bottom);
 138 void MarkWholeScreenDirty();
 139
 140 void GfxInitPalettes();
 141 void CheckBlitter();
 142
 143 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height);
 144
 145 /**
 146  * Determine where to draw a centred object inside a widget.
 147  * @param min The top or left coordinate.
 148  * @param max The bottom or right coordinate.
 149  * @param size The height or width of the object to draw.
 150  * @return Offset of where to start drawing the object.
 151  */
 152 static inline int CenterBounds(int min, int max, int size)
 153 {
 154         return min + (max - min - size + 1) / 2;
 155 }
 156
 157 /* window.cpp */
 158 void DrawOverlappedWindowForAll(int left, int top, int right, int bottom);
 159
 160 void SetMouseCursorBusy(bool busy);
 161 void SetMouseCursor(CursorID cursor, PaletteID pal);
 162 void SetAnimatedMouseCursor(const AnimCursor *table);
 163 void CursorTick();
 164 void UpdateCursorSize();
 165 bool ChangeResInGame(int w, int h);
 166 void SortResolutions(int count);
 167 bool ToggleFullScreen(bool fs);
 168
 169 /* gfx.cpp */
 170 byte GetCharacterWidth(FontSize size, uint32 key);
 171 byte GetDigitWidth(FontSize size = FS_NORMAL);
 172 void GetBroadestDigit(uint *front, uint *next, FontSize size = FS_NORMAL);
 173
 174
 175 extern int font_height_cache[FS_END];
 176
 177 /**
 178  * Get height of a character for a given font size.
 179  * @param size Font size to get height of
 180  * @return     Height of characters in the given font (pixels)
 181  */
 182 inline int GetCharacterHeight(FontSize size)
 183 {
 184         return font_height_cache[size];
 185 }
 186
 187 /** Height of characters in the small (#FS_SMALL) font. @note Some characters may be oversized. */
 188 #define FONT_HEIGHT_SMALL  (GetCharacterHeight(FS_SMALL))
 189
 190 /** Height of characters in the normal (#FS_NORMAL) font. @note Some characters may be oversized. */
 191 #define FONT_HEIGHT_NORMAL (GetCharacterHeight(FS_NORMAL))
 192
 193 /** Height of characters in the large (#FS_LARGE) font. @note Some characters may be oversized. */
 194 #define FONT_HEIGHT_LARGE  (GetCharacterHeight(FS_LARGE))
 195
 196 /** Height of characters in the large (#FS_MONO) font. @note Some characters may be oversized. */
 197 #define FONT_HEIGHT_MONO  (GetCharacterHeight(FS_MONO))
 198
 199 extern DrawPixelInfo *_cur_dpi;
 200
 201 TextColour GetContrastColour(uint8 background, uint8 threshold = 128);
 202
 203 /**
 204  * All 16 colour gradients
 205  * 8 colours per gradient from darkest (0) to lightest (7)
 206  */
 207 extern byte _colour_gradient[COLOUR_END][8];
 208
 209 extern bool _palette_remap_grf[];
 210
 211 /**
 212  * Return the colour for a particular greyscale level.
 213  * @param level Intensity, 0 = black, 15 = white
 214  * @return colour
 215  */
 216 #define GREY_SCALE(level) (level)
 217
 218 static const uint8 PC_BLACK              = GREY_SCALE(1);  ///< Black palette colour.
 219 static const uint8 PC_DARK_GREY          = GREY_SCALE(6);  ///< Dark grey palette colour.
 220 static const uint8 PC_GREY               = GREY_SCALE(10); ///< Grey palette colour.
 221 static const uint8 PC_WHITE              = GREY_SCALE(15); ///< White palette colour.
 222
 223 static const uint8 PC_VERY_DARK_RED      = 0xB2;           ///< Almost-black red palette colour.
 224 static const uint8 PC_DARK_RED           = 0xB4;           ///< Dark red palette colour.
 225 static const uint8 PC_RED                = 0xB8;           ///< Red palette colour.
 226
 227 static const uint8 PC_VERY_DARK_BROWN    = 0x56;           ///< Almost-black brown palette colour.
 228
 229 static const uint8 PC_ORANGE             = 0xC2;           ///< Orange palette colour.
 230
 231 static const uint8 PC_YELLOW             = 0xBF;           ///< Yellow palette colour.
 232 static const uint8 PC_LIGHT_YELLOW       = 0x44;           ///< Light yellow palette colour.
 233 static const uint8 PC_VERY_LIGHT_YELLOW  = 0x45;           ///< Almost-white yellow palette colour.
 234
 235 static const uint8 PC_GREEN              = 0xD0;           ///< Green palette colour.
 236
 237 static const uint8 PC_DARK_BLUE          = 0x9D;           ///< Dark blue palette colour.
 238 static const uint8 PC_LIGHT_BLUE         = 0x98;           ///< Light blue palette colour.
 239
 240 #endif /* GFX_FUNC_H */