OpenTTD Source: src/gfx_func.h Source File

OpenTTD Source 15.0-beta1

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
47void GameLoop();
48
49void CreateConsole();
50
51extern uint8_t _dirkeys;
52extern bool _fullscreen;
53extern uint8_t _support8bpp;
54extern CursorVars _cursor;
55extern bool _ctrl_pressed;
56extern bool _shift_pressed;
57extern uint16_t _game_speed;
58
59extern bool _left_button_down;
60extern bool _left_button_clicked;
61extern bool _right_button_down;
62extern bool _right_button_clicked;
63
64extern DrawPixelInfo _screen;
65extern bool _screen_disable_anim;
66
67extern std::vector<Dimension> _resolutions;
68extern Dimension _cur_resolution;
69extern Palette _cur_palette;
70
71void HandleToolbarHotkey(int hotkey);
72void HandleKeypress(uint keycode, char32_t key);
73void HandleTextInput(const char *str, bool marked = false, const char *caret = nullptr, const char *insert_location = nullptr, const char *replacement_end = nullptr);
74void HandleCtrlChanged();
75void HandleMouseEvents();
76void UpdateWindows();
77void ChangeGameSpeed(bool enable_fast_forward);
78
79void DrawMouseCursor();
80void ScreenSizeChanged();
81void GameSizeChanged();
82void UpdateGUIZoom();
83bool AdjustGUIZoom(bool automatic);
84void UndrawMouseCursor();
85
86void RedrawScreenRect(int left, int top, int right, int bottom);
87void GfxScroll(int left, int top, int width, int height, int xo, int yo);
88
89 Dimension GetSpriteSize(SpriteID sprid, Point *offset = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
90 Dimension GetScaledSpriteSize(SpriteID sprid); /* widget.cpp */
91void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr);
92void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = nullptr, ZoomLevel zoom = ZOOM_LVL_GUI);
93void DrawSpriteIgnorePadding(SpriteID img, PaletteID pal, const Rect &r, StringAlignment align); /* widget.cpp */
94std::unique_ptr<uint32_t[]> DrawSpriteToRgbaBuffer(SpriteID spriteId, ZoomLevel zoom = ZOOM_LVL_GUI);
95
96int 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);
97int DrawString(int left, int right, int top, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL);
98int 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);
99int 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);
100
101void DrawCharCentered(char32_t c, const Rect &r, TextColour colour);
102
103void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode = FILLRECT_OPAQUE);
104void GfxFillPolygon(const std::vector<Point> &shape, int colour, FillRectMode mode = FILLRECT_OPAQUE);
105void GfxDrawLine(int left, int top, int right, int bottom, int colour, int width = 1, int dash = 0);
106void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3);
107void DrawRectOutline(const Rect &r, int colour, int width = 1, int dash = 0);
108
109/* Versions of DrawString/DrawStringMultiLine that accept a Rect instead of separate left, right, top and bottom parameters. */
110inline int DrawString(const Rect &r, std::string_view str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL)
111{
112 return DrawString(r.left, r.right, r.top, str, colour, align, underline, fontsize);
113}
114
115inline int DrawString(const Rect &r, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL)
116{
117 return DrawString(r.left, r.right, r.top, str, colour, align, underline, fontsize);
118}
119
120inline 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)
121{
122 return DrawStringMultiLine(r.left, r.right, r.top, r.bottom, str, colour, align, underline, fontsize);
123}
124
125inline int DrawStringMultiLine(const Rect &r, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL)
126{
127 return DrawStringMultiLine(r.left, r.right, r.top, r.bottom, str, colour, align, underline, fontsize);
128}
129
130inline void GfxFillRect(const Rect &r, int colour, FillRectMode mode = FILLRECT_OPAQUE)
131{
132 GfxFillRect(r.left, r.top, r.right, r.bottom, colour, mode);
133}
134
135 Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize = FS_NORMAL);
136 Dimension GetStringBoundingBox(StringID strid, FontSize start_fontsize = FS_NORMAL);
137uint GetStringListWidth(std::span<const StringID> list, FontSize fontsize = FS_NORMAL);
138 Dimension GetStringListBoundingBox(std::span<const StringID> list, FontSize fontsize = FS_NORMAL);
139int GetStringHeight(std::string_view str, int maxw, FontSize fontsize = FS_NORMAL);
140int GetStringHeight(StringID str, int maxw);
141int GetStringLineCount(StringID str, int maxw);
142 Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion);
143 Dimension GetStringMultiLineBoundingBox(std::string_view str, const Dimension &suggestion);
144void LoadStringWidthTable(bool monospace = false);
145
146void DrawDirtyBlocks();
147void AddDirtyBlock(int left, int top, int right, int bottom);
148void MarkWholeScreenDirty();
149
150void CheckBlitter();
151
152bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height);
153
154inline 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 */
172void DrawOverlappedWindowForAll(int left, int top, int right, int bottom);
173
174void SetMouseCursorBusy(bool busy);
175void SetMouseCursor(CursorID cursor, PaletteID pal);
176void SetAnimatedMouseCursor(const AnimCursor *table);
177void CursorTick();
178void UpdateCursorSize();
179bool ChangeResInGame(int w, int h);
180void SortResolutions();
181bool ToggleFullScreen(bool fs);
182
183/* gfx.cpp */
184uint8_t GetCharacterWidth(FontSize size, char32_t key);
185uint8_t GetDigitWidth(FontSize size = FS_NORMAL);
186void GetBroadestDigit(uint *front, uint *next, FontSize size = FS_NORMAL);
187
188int GetCharacterHeight(FontSize size);
189
190extern DrawPixelInfo *_cur_dpi;
191
192#endif /* GFX_FUNC_H */
GetStringBoundingBox
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize=FS_NORMAL)
Return the string dimension in pixels.
Definition gfx.cpp:851
UpdateCursorSize
void UpdateCursorSize()
Update cursor dimension.
Definition gfx.cpp:1598
_shift_pressed
bool _shift_pressed
Is Shift pressed?
Definition gfx.cpp:39
HandleCtrlChanged
void HandleCtrlChanged()
State of CONTROL key has changed.
Definition window.cpp:2625
GfxFillPolygon
void GfxFillPolygon(const std::vector< Point > &shape, int colour, FillRectMode mode=FILLRECT_OPAQUE)
Fill a polygon with colour.
Definition gfx.cpp:210
UpdateWindows
void UpdateWindows()
Update the continuously changing contents of the windows, such as the viewports.
Definition window.cpp:3056
_left_button_down
bool _left_button_down
Is left mouse button pressed?
Definition gfx.cpp:41
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:919
GetStringListBoundingBox
Dimension GetStringListBoundingBox(std::span< const StringID > list, FontSize fontsize=FS_NORMAL)
Get maximum dimension of a list of strings.
Definition gfx.cpp:889
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:1144
GetStringLineCount
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition gfx.cpp:728
DrawRectOutline
void DrawRectOutline(const Rect &r, int colour, int width=1, int dash=0)
Draw the outline of a Rect.
Definition gfx.cpp:456
HandleToolbarHotkey
void HandleToolbarHotkey(int hotkey)
Handle Toolbar hotkey events - can come from a source like the MacBook Touch Bar.
Definition window.cpp:2552
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:38
GameSizeChanged
void GameSizeChanged()
Size of the application screen changed.
Definition main_gui.cpp:589
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:988
_dirkeys
uint8_t _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition gfx.cpp:34
_screen_disable_anim
bool _screen_disable_anim
Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
Definition gfx.cpp:46
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition gfx.cpp:42
SetMouseCursor
void SetMouseCursor(CursorID cursor, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition gfx.cpp:1686
_game_speed
uint16_t _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
Definition gfx.cpp:40
GetScaledSpriteSize
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
Definition widget.cpp:54
SetMouseCursorBusy
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition gfx.cpp:1670
UpdateGUIZoom
void UpdateGUIZoom()
Resolve GUI zoom level, if auto-suggestion is requested.
Definition gfx.cpp:1770
GetDigitWidth
uint8_t GetDigitWidth(FontSize size=FS_NORMAL)
Return the maximum width of single digit.
Definition gfx.cpp:1240
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:774
CheckBlitter
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
Definition gfxinit.cpp:313
GetStringHeight
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize=FS_NORMAL)
Calculates height of string (in pixels).
Definition gfx.cpp:704
HandleMouseEvents
void HandleMouseEvents()
Handle a mouse event from the video driver.
Definition window.cpp:2885
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:1255
_cur_palette
Palette _cur_palette
Current palette.
Definition palette.cpp:24
DrawSpriteViewport
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub=nullptr)
Draw a sprite in a viewport.
Definition gfx.cpp:960
_right_button_clicked
bool _right_button_clicked
Is right mouse button clicked?
Definition gfx.cpp:44
HandleKeypress
void HandleKeypress(uint keycode, char32_t key)
Handle keyboard input.
Definition window.cpp:2569
CenterBounds
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition gfx_func.h:166
GetCharacterWidth
uint8_t GetCharacterWidth(FontSize size, char32_t key)
Return width of character glyph.
Definition gfx.cpp:1227
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:2655
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset=nullptr, ZoomLevel zoom=ZOOM_LVL_GUI)
Get the size of a sprite.
Definition gfx.cpp:922
LoadStringWidthTable
void LoadStringWidthTable(bool monospace=false)
Initialize _stringwidth_table cache.
Definition gfx.cpp:1210
SetAnimatedMouseCursor
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition gfx.cpp:1699
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition gfx.cpp:740
_resolutions
std::vector< Dimension > _resolutions
List of resolutions.
Definition driver.cpp:25
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:77
_cur_resolution
Dimension _cur_resolution
The current resolution.
Definition driver.cpp:26
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
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
GetStringListWidth
uint GetStringListWidth(std::span< const StringID > list, FontSize fontsize=FS_NORMAL)
Get maximum width of a list of strings.
Definition gfx.cpp:874
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:657
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:1548
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition gfx.cpp:43
AdjustGUIZoom
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
Definition gfx.cpp:1793
DrawCharCentered
void DrawCharCentered(char32_t c, const Rect &r, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition gfx.cpp:905
gfx_type.h
Types related to the graphics and/or input devices.
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:18
StringAlignment
StringAlignment
How to align the to-be drawn text.
Definition gfx_type.h:342
SA_TOP
@ SA_TOP
Top align the text.
Definition gfx_type.h:348
SA_LEFT
@ SA_LEFT
Left align the text.
Definition gfx_type.h:343
CursorID
uint32_t CursorID
The number of the cursor (sprite)
Definition gfx_type.h:20
FontSize
FontSize
Available font sizes.
Definition gfx_type.h:208
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:209
PaletteID
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:19
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:260
FillRectMode
FillRectMode
Define the operation GfxFillRect performs.
Definition gfx_type.h:297
FILLRECT_OPAQUE
@ FILLRECT_OPAQUE
Fill rectangle with a single colour.
Definition gfx_type.h:298
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:1486
DrawDirtyBlocks
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as 'dirty'.
Definition gfx.cpp:1397
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1529
RedrawScreenRect
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
Definition gfx.cpp:1371
string_type.h
Types for strings.
strings_type.h
Types related to strings.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:16
AnimCursor
A single sprite of a list of animated cursors.
Definition gfx_type.h:109
CursorVars
Collection of variables for cursor-display and -animation.
Definition gfx_type.h:123
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition geometry_type.hpp:30
DrawPixelInfo
Data about how and where to blit pixels.
Definition gfx_type.h:157
Palette
Information about the currently used palette.
Definition gfx_type.h:328
Point
Coordinates of a point in 2D.
Definition geometry_type.hpp:21
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition geometry_type.hpp:75
Rect::Width
int Width() const
Get width of Rect.
Definition geometry_type.hpp:85
Rect::Height
int Height() const
Get height of Rect.
Definition geometry_type.hpp:91
SubSprite
Used to only draw a part of the sprite.
Definition gfx_type.h:231
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition zoom_type.h:16