OpenTTD Source  1.11.0-beta2
gfx_func.h
Go to the documentation of this file.
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 
40 #ifndef GFX_FUNC_H
41 #define GFX_FUNC_H
42 
43 #include "gfx_type.h"
44 #include "strings_type.h"
45 #include "string_type.h"
46 
47 void GameLoop();
48 
49 void CreateConsole();
50 
51 extern byte _dirkeys;
52 extern bool _fullscreen;
53 extern byte _support8bpp;
54 extern CursorVars _cursor;
55 extern bool _ctrl_pressed;
56 extern bool _shift_pressed;
57 extern uint16 _game_speed;
58 
59 extern bool _left_button_down;
60 extern bool _left_button_clicked;
61 extern bool _right_button_down;
62 extern bool _right_button_clicked;
63 
64 extern DrawPixelInfo _screen;
65 extern bool _screen_disable_anim;
66 
67 extern std::vector<Dimension> _resolutions;
69 extern Palette _cur_palette;
70 
71 void HandleKeypress(uint keycode, WChar key);
72 void HandleTextInput(const char *str, bool marked = false, const char *caret = nullptr, const char *insert_location = nullptr, const char *replacement_end = nullptr);
73 void HandleCtrlChanged();
74 void HandleMouseEvents();
75 void UpdateWindows();
76 void ChangeGameSpeed(bool enable_fast_forward);
77 
78 void DrawMouseCursor();
79 void ScreenSizeChanged();
80 void GameSizeChanged();
81 void UpdateGUIZoom();
82 void UndrawMouseCursor();
83 
85 static const int DRAW_STRING_BUFFER = 2048;
86 
87 void RedrawScreenRect(int left, int top, int right, int bottom);
88 void GfxScroll(int left, int top, int width, int height, int xo, int yo);
89 
90 Dimension GetSpriteSize(SpriteID sprid, Point *offset = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
91 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr);
92 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
93 
96  SA_LEFT = 0 << 0,
97  SA_HOR_CENTER = 1 << 0,
98  SA_RIGHT = 2 << 0,
99  SA_HOR_MASK = 3 << 0,
100 
101  SA_TOP = 0 << 2,
102  SA_VERT_CENTER = 1 << 2,
103  SA_BOTTOM = 2 << 2,
104  SA_VERT_MASK = 3 << 2,
105 
107 
108  SA_FORCE = 1 << 4,
109 };
111 
112 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);
113 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);
114 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);
115 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);
116 
117 void DrawCharCentered(WChar c, int x, int y, TextColour colour);
118 
119 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode = FILLRECT_OPAQUE);
120 void GfxFillPolygon(const std::vector<Point> &shape, int colour, FillRectMode mode = FILLRECT_OPAQUE);
121 void GfxDrawLine(int left, int top, int right, int bottom, int colour, int width = 1, int dash = 0);
122 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3);
123 
124 Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize = FS_NORMAL);
126 int GetStringHeight(const char *str, int maxw, FontSize fontsize = FS_NORMAL);
127 int GetStringHeight(StringID str, int maxw);
128 int GetStringLineCount(StringID str, int maxw);
130 Dimension GetStringMultiLineBoundingBox(const char *str, const Dimension &suggestion);
131 void LoadStringWidthTable(bool monospace = false);
132 Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize = FS_NORMAL);
133 const char *GetCharAtPosition(const char *str, int x, FontSize start_fontsize = FS_NORMAL);
134 
135 void DrawDirtyBlocks();
136 void AddDirtyBlock(int left, int top, int right, int bottom);
137 void MarkWholeScreenDirty();
138 
139 void GfxInitPalettes();
140 void CheckBlitter();
141 
142 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height);
143 
151 static inline int CenterBounds(int min, int max, int size)
152 {
153  return min + (max - min - size + 1) / 2;
154 }
155 
156 /* window.cpp */
157 void DrawOverlappedWindowForAll(int left, int top, int right, int bottom);
158 
159 void SetMouseCursorBusy(bool busy);
160 void SetMouseCursor(CursorID cursor, PaletteID pal);
161 void SetAnimatedMouseCursor(const AnimCursor *table);
162 void CursorTick();
163 void UpdateCursorSize();
164 bool ChangeResInGame(int w, int h);
165 void SortResolutions();
166 bool ToggleFullScreen(bool fs);
167 
168 /* gfx.cpp */
169 byte GetCharacterWidth(FontSize size, WChar key);
170 byte GetDigitWidth(FontSize size = FS_NORMAL);
171 void GetBroadestDigit(uint *front, uint *next, FontSize size = FS_NORMAL);
172 
173 int GetCharacterHeight(FontSize size);
174 
176 #define FONT_HEIGHT_SMALL (GetCharacterHeight(FS_SMALL))
177 
179 #define FONT_HEIGHT_NORMAL (GetCharacterHeight(FS_NORMAL))
180 
182 #define FONT_HEIGHT_LARGE (GetCharacterHeight(FS_LARGE))
183 
185 #define FONT_HEIGHT_MONO (GetCharacterHeight(FS_MONO))
186 
187 extern DrawPixelInfo *_cur_dpi;
188 
189 TextColour GetContrastColour(uint8 background, uint8 threshold = 128);
190 
195 extern byte _colour_gradient[COLOUR_END][8];
196 
197 extern bool _palette_remap_grf[];
198 
204 #define GREY_SCALE(level) (level)
205 
206 static const uint8 PC_BLACK = GREY_SCALE(1);
207 static const uint8 PC_DARK_GREY = GREY_SCALE(6);
208 static const uint8 PC_GREY = GREY_SCALE(10);
209 static const uint8 PC_WHITE = GREY_SCALE(15);
210 
211 static const uint8 PC_VERY_DARK_RED = 0xB2;
212 static const uint8 PC_DARK_RED = 0xB4;
213 static const uint8 PC_RED = 0xB8;
214 
215 static const uint8 PC_VERY_DARK_BROWN = 0x56;
216 
217 static const uint8 PC_ORANGE = 0xC2;
218 
219 static const uint8 PC_YELLOW = 0xBF;
220 static const uint8 PC_LIGHT_YELLOW = 0x44;
221 static const uint8 PC_VERY_LIGHT_YELLOW = 0x45;
222 
223 static const uint8 PC_GREEN = 0xD0;
224 
225 static const uint8 PC_VERY_DARK_BLUE = 0x9A;
226 static const uint8 PC_DARK_BLUE = 0x9D;
227 static const uint8 PC_LIGHT_BLUE = 0x98;
228 
229 static const uint8 PC_ROUGH_LAND = 0x52;
230 static const uint8 PC_GRASS_LAND = 0x54;
231 static const uint8 PC_BARE_LAND = 0x37;
232 static const uint8 PC_RAINFOREST = 0x5C;
233 static const uint8 PC_FIELDS = 0x25;
234 static const uint8 PC_TREES = 0x57;
235 static const uint8 PC_WATER = 0xC9;
236 #endif /* GFX_FUNC_H */
_cur_palette
Palette _cur_palette
Current palette.
Definition: gfx.cpp:48
SetMouseCursorBusy
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition: gfx.cpp:1760
PC_WHITE
static const uint8 PC_WHITE
White palette colour.
Definition: gfx_func.h:209
SetMouseCursor
void SetMouseCursor(CursorID cursor, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition: gfx.cpp:1775
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:39
_dirkeys
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:31
SA_HOR_MASK
@ SA_HOR_MASK
Mask for horizontal alignment.
Definition: gfx_func.h:99
CursorVars
Collection of variables for cursor-display and -animation.
Definition: gfx_type.h:115
_left_button_down
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:38
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
AddDirtyBlock
void AddDirtyBlock(int left, int top, int right, int bottom)
Extend the internal _invalid_rect rectangle to contain the rectangle defined by the given parameters.
Definition: gfx.cpp:1576
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:40
UpdateGUIZoom
void UpdateGUIZoom()
Resolve GUI zoom level, if auto-suggestion is requested.
Definition: gfx.cpp:1892
DrawSpriteViewport
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub=nullptr)
Draw a sprite in a viewport.
Definition: gfx.cpp:951
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
HandleTextInput
void HandleTextInput(const char *str, bool marked=false, const char *caret=nullptr, const char *insert_location=nullptr, const char *replacement_end=nullptr)
Handle text input.
Definition: window.cpp:2769
PC_YELLOW
static const uint8 PC_YELLOW
Yellow palette colour.
Definition: gfx_func.h:219
PC_DARK_RED
static const uint8 PC_DARK_RED
Dark red palette colour.
Definition: gfx_func.h:212
HandleKeypress
void HandleKeypress(uint keycode, WChar key)
Handle keyboard input.
Definition: window.cpp:2681
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_func.h:98
PC_ORANGE
static const uint8 PC_ORANGE
Orange palette colour.
Definition: gfx_func.h:217
PC_RED
static const uint8 PC_RED
Red palette colour.
Definition: gfx_func.h:213
GfxFillPolygon
void GfxFillPolygon(const std::vector< Point > &shape, int colour, FillRectMode mode=FILLRECT_OPAQUE)
Fill a polygon with colour.
Definition: gfx.cpp:210
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_func.h:96
PC_RAINFOREST
static const uint8 PC_RAINFOREST
Pale green palette colour for rainforest.
Definition: gfx_func.h:232
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize=FS_NORMAL)
Calculates height of string (in pixels).
Definition: gfx.cpp:689
StringAlignment
StringAlignment
How to align the to-be drawn text.
Definition: gfx_func.h:95
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
FillRectMode
FillRectMode
Define the operation GfxFillRect performs.
Definition: gfx_type.h:286
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset=nullptr, ZoomLevel zoom=ZOOM_LVL_GUI)
Get the size of a sprite.
Definition: gfx.cpp:913
SA_BOTTOM
@ SA_BOTTOM
Bottom align the text.
Definition: gfx_func.h:103
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_func.h:106
_screen_disable_anim
bool _screen_disable_anim
Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
Definition: gfx.cpp:43
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_func.h:108
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_func.h:97
PC_GRASS_LAND
static const uint8 PC_GRASS_LAND
Dark green palette colour for grass land.
Definition: gfx_func.h:230
strings_type.h
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode=FILLRECT_OPAQUE)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:114
SubSprite
Used to only draw a part of the sprite.
Definition: gfx_type.h:222
_cur_resolution
Dimension _cur_resolution
The current resolution.
Definition: driver.cpp:23
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
SA_TOP
@ SA_TOP
Top align the text.
Definition: gfx_func.h:101
UpdateWindows
void UpdateWindows()
Update the continuously changing contents of the windows, such as the viewports.
Definition: window.cpp:3140
PC_VERY_LIGHT_YELLOW
static const uint8 PC_VERY_LIGHT_YELLOW
Almost-white yellow palette colour.
Definition: gfx_func.h:221
DrawOverlappedWindowForAll
void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)
From a rectangle that needs redrawing, find the windows that intersect with the rectangle.
Definition: window.cpp:959
SetAnimatedMouseCursor
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition: gfx.cpp:1788
FillDrawPixelInfo
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1638
DRAW_STRING_BUFFER
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:85
CursorID
uint32 CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:19
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:207
DrawString
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)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:640
HandleMouseEvents
void HandleMouseEvents()
Handle a mouse event from the video driver.
Definition: window.cpp:2989
DrawStringMultiLine
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)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:763
GetCharPosInString
Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize=FS_NORMAL)
Get the leading corner of a character in a single-line string relative to the start of the string.
Definition: gfx.cpp:870
_right_button_clicked
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:41
SA_VERT_CENTER
@ SA_VERT_CENTER
Vertically center the text.
Definition: gfx_func.h:102
GetCharacterWidth
byte GetCharacterWidth(FontSize size, WChar key)
Return width of character glyph.
Definition: gfx.cpp:1295
UpdateCursorSize
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1688
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub=nullptr, ZoomLevel zoom=ZOOM_LVL_GUI)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:978
RedrawScreenRect
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
Definition: gfx.cpp:1439
DrawDirtyBlocks
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as 'dirty'.
Definition: gfx.cpp:1465
GetStringLineCount
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:714
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
CheckBlitter
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
Definition: gfxinit.cpp:332
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:729
string_type.h
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:206
GetContrastColour
TextColour GetContrastColour(uint8 background, uint8 threshold=128)
Determine a contrasty text colour for a coloured background.
Definition: gfx.cpp:1262
PC_TREES
static const uint8 PC_TREES
Green palette colour for trees.
Definition: gfx_func.h:234
_resolutions
std::vector< Dimension > _resolutions
List of resolutions.
Definition: driver.cpp:22
PC_GREY
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:208
PC_FIELDS
static const uint8 PC_FIELDS
Light brown palette colour for fields.
Definition: gfx_func.h:233
FILLRECT_OPAQUE
@ FILLRECT_OPAQUE
Fill rectangle with a single colour.
Definition: gfx_type.h:287
PC_VERY_DARK_BROWN
static const uint8 PC_VERY_DARK_BROWN
Almost-black brown palette colour.
Definition: gfx_func.h:215
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
GetBroadestDigit
void GetBroadestDigit(uint *front, uint *next, FontSize size=FS_NORMAL)
Determine the broadest digits for guessing the maximum width of a n-digit number.
Definition: gfx.cpp:1323
PC_VERY_DARK_RED
static const uint8 PC_VERY_DARK_RED
Almost-black red palette colour.
Definition: gfx_func.h:211
SA_VERT_MASK
@ SA_VERT_MASK
Mask for vertical alignment.
Definition: gfx_func.h:104
PC_LIGHT_YELLOW
static const uint8 PC_LIGHT_YELLOW
Light yellow palette colour.
Definition: gfx_func.h:220
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
PC_ROUGH_LAND
static const uint8 PC_ROUGH_LAND
Dark green palette colour for rough land.
Definition: gfx_func.h:229
PC_DARK_BLUE
static const uint8 PC_DARK_BLUE
Dark blue palette colour.
Definition: gfx_func.h:226
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
GetDigitWidth
byte GetDigitWidth(FontSize size=FS_NORMAL)
Return the maximum width of single digit.
Definition: gfx.cpp:1308
LoadStringWidthTable
void LoadStringWidthTable(bool monospace=false)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1276
GetCharAtPosition
const char * GetCharAtPosition(const char *str, int x, FontSize start_fontsize=FS_NORMAL)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:883
PC_VERY_DARK_BLUE
static const uint8 PC_VERY_DARK_BLUE
Almost-black blue palette colour.
Definition: gfx_func.h:225
AnimCursor
A single sprite of a list of animated cursors.
Definition: gfx_type.h:108
PC_WATER
static const uint8 PC_WATER
Dark blue palette colour for water.
Definition: gfx_func.h:235
_palette_remap_grf
bool _palette_remap_grf[]
Whether the given NewGRFs must get a palette remap from windows to DOS or not.
Definition: gfxinit.cpp:30
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:29
GameSizeChanged
void GameSizeChanged()
Size of the application screen changed.
Definition: main_gui.cpp:561
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:69
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize=FS_NORMAL)
Return the string dimension in pixels.
Definition: gfx.cpp:842
CenterBounds
static int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:151
HandleCtrlChanged
void HandleCtrlChanged()
State of CONTROL key has changed.
Definition: window.cpp:2738
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1619
DrawBox
void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
Draws the projection of a parallelepiped.
Definition: gfx.cpp:418
_shift_pressed
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:36
FontSize
FontSize
Available font sizes.
Definition: gfx_type.h:206
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
GREY_SCALE
#define GREY_SCALE(level)
Return the colour for a particular greyscale level.
Definition: gfx_func.h:204
PC_DARK_GREY
static const uint8 PC_DARK_GREY
Dark grey palette colour.
Definition: gfx_func.h:207
PC_LIGHT_BLUE
static const uint8 PC_LIGHT_BLUE
Light blue palette colour.
Definition: gfx_func.h:227
DrawCharCentered
void DrawCharCentered(WChar c, int x, int y, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:899
gfx_type.h
Palette
Information about the currently used palette.
Definition: gfx_type.h:313
_game_speed
uint16 _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
Definition: gfx.cpp:37
PC_GREEN
static const uint8 PC_GREEN
Green palette colour.
Definition: gfx_func.h:223
PC_BARE_LAND
static const uint8 PC_BARE_LAND
Brown palette colour for bare land.
Definition: gfx_func.h:231
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155