OpenTTD Source: src/gfx_func.h Source File

OpenTTD Source 14.0-RC3

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_t _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;
68 extern Dimension _cur_resolution;
69 extern Palette _cur_palette;
70
71 void HandleToolbarHotkey(int hotkey);
72 void HandleKeypress(uint keycode, char32_t key);
73 void HandleTextInput(const char *str, bool marked = false, const char *caret = nullptr, const char *insert_location = nullptr, const char *replacement_end = nullptr);
74 void HandleCtrlChanged();
75 void HandleMouseEvents();
76 void UpdateWindows();
77 void ChangeGameSpeed(bool enable_fast_forward);
78
79 void DrawMouseCursor();
80 void ScreenSizeChanged();
81 void GameSizeChanged();
82 bool AdjustGUIZoom(bool automatic);
83 void UndrawMouseCursor();
84
85 void RedrawScreenRect(int left, int top, int right, int bottom);
86 void GfxScroll(int left, int top, int width, int height, int xo, int yo);
87
88 Dimension GetSpriteSize(SpriteID sprid, Point *offset = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
89 Dimension GetScaledSpriteSize(SpriteID sprid); /* widget.cpp */
90 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr);
91 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
92 void DrawSpriteIgnorePadding(SpriteID img, PaletteID pal, const Rect &r, StringAlignment align); /* widget.cpp */
93 std::unique_ptr<uint32_t[]> DrawSpriteToRgbaBuffer(SpriteID spriteId, ZoomLevel zoom = ZOOM_LVL_GUI);
94
95 int DrawString(int left, int right, int top, std::string_view str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL);
96 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);
97 int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL);
98 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);
99
100 void DrawCharCentered(char32_t c, const Rect &r, TextColour colour);
101
102 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode = FILLRECT_OPAQUE);
103 void GfxFillPolygon(const std::vector<Point> &shape, int colour, FillRectMode mode = FILLRECT_OPAQUE);
104 void GfxDrawLine(int left, int top, int right, int bottom, int colour, int width = 1, int dash = 0);
105 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3);
106 void DrawRectOutline(const Rect &r, int colour, int width = 1, int dash = 0);
107
108 /* Versions of DrawString/DrawStringMultiLine that accept a Rect instead of separate left, right, top and bottom parameters. */
109 inline int DrawString(const Rect &r, std::string_view str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL)
110 {
111 return DrawString(r.left, r.right, r.top, str, colour, align, underline, fontsize);
112 }
113
114 inline int DrawString(const Rect &r, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL)
115 {
116 return DrawString(r.left, r.right, r.top, str, colour, align, underline, fontsize);
117 }
118
119 inline int DrawStringMultiLine(const Rect &r, std::string_view str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL)
120 {
121 return DrawStringMultiLine(r.left, r.right, r.top, r.bottom, str, colour, align, underline, fontsize);
122 }
123
124 inline int DrawStringMultiLine(const Rect &r, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL)
125 {
126 return DrawStringMultiLine(r.left, r.right, r.top, r.bottom, str, colour, align, underline, fontsize);
127 }
128
129 inline void GfxFillRect(const Rect &r, int colour, FillRectMode mode = FILLRECT_OPAQUE)
130 {
131 GfxFillRect(r.left, r.top, r.right, r.bottom, colour, mode);
132 }
133
134 Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize = FS_NORMAL);
135 Dimension GetStringBoundingBox(StringID strid, FontSize start_fontsize = FS_NORMAL);
136 uint GetStringListWidth(const StringID *list, FontSize fontsize = FS_NORMAL);
137 int GetStringHeight(std::string_view str, int maxw, FontSize fontsize = FS_NORMAL);
138 int GetStringHeight(StringID str, int maxw);
139 int GetStringLineCount(StringID str, int maxw);
140 Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion);
141 Dimension GetStringMultiLineBoundingBox(std::string_view str, const Dimension &suggestion);
142 void LoadStringWidthTable(bool monospace = false);
143 Point GetCharPosInString(std::string_view str, const char *ch, FontSize start_fontsize = FS_NORMAL);
144 ptrdiff_t GetCharAtPosition(std::string_view str, int x, FontSize start_fontsize = FS_NORMAL);
145
146 void DrawDirtyBlocks();
147 void AddDirtyBlock(int left, int top, int right, int bottom);
148 void MarkWholeScreenDirty();
149
150 void CheckBlitter();
151
152 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height);
153
154 inline bool FillDrawPixelInfo(DrawPixelInfo *n, const Rect &r)
155 {
156 return FillDrawPixelInfo(n, r.left, r.top, r.Width(), r.Height());
157 }
158
166 inline int CenterBounds(int min, int max, int size)
167 {
168 return (min + max - size + 1) / 2;
169 }
170
171 /* window.cpp */
172 void DrawOverlappedWindowForAll(int left, int top, int right, int bottom);
173
174 void SetMouseCursorBusy(bool busy);
175 void SetMouseCursor(CursorID cursor, PaletteID pal);
176 void SetAnimatedMouseCursor(const AnimCursor *table);
177 void CursorTick();
178 void UpdateCursorSize();
179 bool ChangeResInGame(int w, int h);
180 void SortResolutions();
181 bool ToggleFullScreen(bool fs);
182
183 /* gfx.cpp */
184 byte GetCharacterWidth(FontSize size, char32_t key);
185 byte GetDigitWidth(FontSize size = FS_NORMAL);
186 void GetBroadestDigit(uint *front, uint *next, FontSize size = FS_NORMAL);
187
188 int GetCharacterHeight(FontSize size);
189
190 extern DrawPixelInfo *_cur_dpi;
191
192 #endif /* GFX_FUNC_H */
_cur_palette
Palette _cur_palette
Current palette.
Definition: palette.cpp:24
SetMouseCursorBusy
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition: gfx.cpp:1689
SetMouseCursor
void SetMouseCursor(CursorID cursor, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition: gfx.cpp:1704
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:41
_dirkeys
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:33
Rect::Height
int Height() const
Get height of Rect.
Definition: geometry_type.hpp:91
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:40
DrawSpriteToRgbaBuffer
std::unique_ptr< uint32_t[]> DrawSpriteToRgbaBuffer(SpriteID spriteId, ZoomLevel zoom=ZOOM_LVL_GUI)
Draws a sprite to a new RGBA buffer (see Colour union) instead of drawing to the screen.
Definition: gfx.cpp:1159
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:1505
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:42
DrawSpriteViewport
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub=nullptr)
Draw a sprite in a viewport.
Definition: gfx.cpp:975
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:30
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:2653
HandleKeypress
void HandleKeypress(uint keycode, char32_t key)
Handle keyboard input.
Definition: window.cpp:2567
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
GfxFillPolygon
void GfxFillPolygon(const std::vector< Point > &shape, int colour, FillRectMode mode=FILLRECT_OPAQUE)
Fill a polygon with colour.
Definition: gfx.cpp:209
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:253
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:19
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view 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:771
StringAlignment
StringAlignment
How to align the to-be drawn text.
Definition: gfx_type.h:337
FillRectMode
FillRectMode
Define the operation GfxFillRect performs.
Definition: gfx_type.h:292
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset=nullptr, ZoomLevel zoom=ZOOM_LVL_GUI)
Get the size of a sprite.
Definition: gfx.cpp:937
GetStringHeight
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize=FS_NORMAL)
Calculates height of string (in pixels).
Definition: gfx.cpp:701
_screen_disable_anim
bool _screen_disable_anim
Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
Definition: gfx.cpp:45
strings_type.h
GetStringBoundingBox
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize=FS_NORMAL)
Return the string dimension in pixels.
Definition: gfx.cpp:848
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:113
SubSprite
Used to only draw a part of the sprite.
Definition: gfx_type.h:225
PaletteID
uint32_t PaletteID
The number of the palette.
Definition: gfx_type.h:18
_cur_resolution
Dimension _cur_resolution
The current resolution.
Definition: driver.cpp:32
GetStringListWidth
uint GetStringListWidth(const StringID *list, FontSize fontsize=FS_NORMAL)
Get maximum width of a list of strings.
Definition: gfx.cpp:871
UpdateWindows
void UpdateWindows()
Update the continuously changing contents of the windows, such as the viewports.
Definition: window.cpp:3041
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:920
_game_speed
uint16_t _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
Definition: gfx.cpp:39
SetAnimatedMouseCursor
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition: gfx.cpp:1717
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:1567
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:203
SA_TOP
@ SA_TOP
Top align the text.
Definition: gfx_type.h:343
HandleMouseEvents
void HandleMouseEvents()
Handle a mouse event from the video driver.
Definition: window.cpp:2870
_right_button_clicked
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:43
UpdateCursorSize
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1617
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:1003
CursorID
uint32_t CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:19
RedrawScreenRect
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
Definition: gfx.cpp:1390
DrawDirtyBlocks
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as 'dirty'.
Definition: gfx.cpp:1416
GetStringLineCount
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:725
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:317
CenterBounds
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:166
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:737
DrawRectOutline
void DrawRectOutline(const Rect &r, int colour, int width=1, int dash=0)
Draw the outline of a Rect.
Definition: gfx.cpp:455
string_type.h
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
_resolutions
std::vector< Dimension > _resolutions
List of resolutions.
Definition: driver.cpp:31
DrawString
int DrawString(int left, int right, int top, std::string_view 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:654
GetCharPosInString
Point GetCharPosInString(std::string_view 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:888
FILLRECT_OPAQUE
@ FILLRECT_OPAQUE
Fill rectangle with a single colour.
Definition: gfx_type.h:293
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:1274
DrawCharCentered
void DrawCharCentered(char32_t c, const Rect &r, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:920
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:37
GetDigitWidth
byte GetDigitWidth(FontSize size=FS_NORMAL)
Return the maximum width of single digit.
Definition: gfx.cpp:1259
LoadStringWidthTable
void LoadStringWidthTable(bool monospace=false)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1229
GetCharacterWidth
byte GetCharacterWidth(FontSize size, char32_t key)
Return width of character glyph.
Definition: gfx.cpp:1246
HandleToolbarHotkey
void HandleToolbarHotkey(int hotkey)
Handle Toolbar hotkey events - can come from a source like the MacBook Touch Bar.
Definition: window.cpp:2550
AnimCursor
A single sprite of a list of animated cursors.
Definition: gfx_type.h:108
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_type.h:338
GameSizeChanged
void GameSizeChanged()
Size of the application screen changed.
Definition: main_gui.cpp:583
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:78
HandleCtrlChanged
void HandleCtrlChanged()
State of CONTROL key has changed.
Definition: window.cpp:2623
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1548
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:417
AdjustGUIZoom
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
Definition: gfx.cpp:1810
_shift_pressed
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:38
FontSize
FontSize
Available font sizes.
Definition: gfx_type.h:202
Rect::Width
int Width() const
Get width of Rect.
Definition: geometry_type.hpp:85
GetScaledSpriteSize
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
Definition: widget.cpp:54
gfx_type.h
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:75
Palette
Information about the currently used palette.
Definition: gfx_type.h:323
GetCharAtPosition
ptrdiff_t GetCharAtPosition(std::string_view str, int x, FontSize start_fontsize=FS_NORMAL)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:905
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:151