Handling of drawing text and other gfx related stuff. More...

#include "stdafx.h"
#include "gfx_layout.h"
#include "progress.h"
#include "zoom_func.h"
#include "blitter/factory.hpp"
#include "video/video_driver.hpp"
#include "strings_func.h"
#include "settings_type.h"
#include "network/network.h"
#include "network/network_func.h"
#include "window_gui.h"
#include "window_func.h"
#include "newgrf_debug.h"
#include "core/backup_type.hpp"
#include "core/container_func.hpp"
#include "core/geometry_func.hpp"
#include "viewport_func.h"
#include "table/string_colours.h"
#include "table/sprites.h"
#include "table/control_codes.h"
#include "safeguards.h"

Typedefs
typedef std::pair< Point, Point >	LineSegment

Functions
static void	GfxMainBlitterViewport (const Sprite sprite, int x, int y, BlitterMode mode, const SubSprite sub=nullptr, SpriteID sprite_id=SPR_CURSOR_MOUSE)

static void	GfxMainBlitter (const Sprite sprite, int x, int y, BlitterMode mode, const SubSprite sub=nullptr, SpriteID sprite_id=SPR_CURSOR_MOUSE, ZoomLevel zoom=ZOOM_LVL_MIN)

void	GfxScroll (int left, int top, int width, int height, int xo, int yo)

void	GfxFillRect (int left, int top, int right, int bottom, int colour, FillRectMode mode)
	Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen. More...

static std::vector< LineSegment >	MakePolygonSegments (const std::vector< Point > &shape, Point offset)
	Make line segments from a polygon defined by points, translated by an offset. More...

void	GfxFillPolygon (const std::vector< Point > &shape, int colour, FillRectMode mode)
	Fill a polygon with colour. More...

static void	GfxDoDrawLine (void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8_t colour, int width, int dash=0)
	Check line clipping by using a linear equation and draw the visible part of the line given by x/y and x2/y2. More...

static bool	GfxPreprocessLine (DrawPixelInfo *dpi, int &x, int &y, int &x2, int &y2, int width)
	Align parameters of a line to the given DPI and check simple clipping. More...

void	GfxDrawLine (int x, int y, int x2, int y2, int colour, int width, int dash)

void	GfxDrawLineUnscaled (int x, int y, int x2, int y2, int colour)

void	DrawBox (int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
	Draws the projection of a parallelepiped. More...

void	DrawRectOutline (const Rect &r, int colour, int width, int dash)
	Draw the outline of a Rect. More...

static void	SetColourRemap (TextColour colour)
	Set the colour remap to be for the given colour. More...

static int	DrawLayoutLine (const ParagraphLayouter::Line &line, int y, int left, int right, StringAlignment align, bool underline, bool truncation, TextColour default_colour)
	Drawing routine for drawing a laid out line of text. More...

int	DrawString (int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
	Draw string, possibly truncated to make it fit in its allocated space. More...

int	DrawString (int left, int right, int top, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
	Draw string, possibly truncated to make it fit in its allocated space. More...

int	GetStringHeight (std::string_view str, int maxw, FontSize fontsize)
	Calculates height of string (in pixels). More...

int	GetStringHeight (StringID str, int maxw)
	Calculates height of string (in pixels). More...

int	GetStringLineCount (StringID str, int maxw)
	Calculates number of lines of string. More...

Dimension	GetStringMultiLineBoundingBox (StringID str, const Dimension &suggestion)
	Calculate string bounding box for multi-line strings. More...

Dimension	GetStringMultiLineBoundingBox (std::string_view str, const Dimension &suggestion)
	Calculate string bounding box for multi-line strings. More...

int	DrawStringMultiLine (int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
	Draw string, possibly over multiple lines. More...

int	DrawStringMultiLine (int left, int right, int top, int bottom, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
	Draw string, possibly over multiple lines. More...

Dimension	GetStringBoundingBox (std::string_view str, FontSize start_fontsize)
	Return the string dimension in pixels. More...

Dimension	GetStringBoundingBox (StringID strid, FontSize start_fontsize)
	Get bounding box of a string. More...

uint	GetStringListWidth (std::span< const StringID > list, FontSize fontsize)
	Get maximum width of a list of strings. More...

Dimension	GetStringListBoundingBox (std::span< const StringID > list, FontSize fontsize)
	Get maximum dimension of a list of strings. More...

void	DrawCharCentered (char32_t c, const Rect &r, TextColour colour)
	Draw single character horizontally centered around (x,y) More...

Dimension	GetSpriteSize (SpriteID sprid, Point *offset, ZoomLevel zoom)
	Get the size of a sprite. More...

static BlitterMode	GetBlitterMode (PaletteID pal)
	Helper function to get the blitter mode for different types of palettes. More...

void	DrawSpriteViewport (SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
	Draw a sprite in a viewport. More...

void	DrawSprite (SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
	Draw a sprite, not in a viewport. More...

template<int ZOOM_BASE, bool SCALED_XY>
static void	GfxBlitter (const Sprite const sprite, int x, int y, BlitterMode mode, const SubSprite const sub, SpriteID sprite_id, ZoomLevel zoom, const DrawPixelInfo *dst=nullptr)
	The code for setting up the blitter mode and sprite information before finally drawing the sprite. More...

std::unique_ptr< uint32_t[]>	DrawSpriteToRgbaBuffer (SpriteID spriteId, ZoomLevel zoom)
	Draws a sprite to a new RGBA buffer (see Colour union) instead of drawing to the screen. More...

void	LoadStringWidthTable (bool monospace)
	Initialize _stringwidth_table cache. More...

uint8_t	GetCharacterWidth (FontSize size, char32_t key)
	Return width of character glyph. More...

uint8_t	GetDigitWidth (FontSize size)
	Return the maximum width of single digit. More...

void	GetBroadestDigit (uint front, uint next, FontSize size)
	Determine the broadest digits for guessing the maximum width of a n-digit number. More...

void	ScreenSizeChanged ()

void	UndrawMouseCursor ()

void	DrawMouseCursor ()

void	RedrawScreenRect (int left, int top, int right, int bottom)
	Repaints a specific rectangle of the screen. More...

void	DrawDirtyBlocks ()
	Repaints the rectangle blocks which are marked as 'dirty'. More...

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. More...

void	MarkWholeScreenDirty ()
	This function mark the whole screen as dirty. More...

bool	FillDrawPixelInfo (DrawPixelInfo *n, int left, int top, int width, int height)
	Set up a clipping area for only drawing into a certain area. More...

void	UpdateCursorSize ()
	Update cursor dimension. More...

static void	SetCursorSprite (CursorID cursor, PaletteID pal)
	Switch cursor to different sprite. More...

static void	SwitchAnimatedCursor ()

void	CursorTick ()

void	SetMouseCursorBusy (bool busy)
	Set or unset the ZZZ cursor. More...

void	SetMouseCursor (CursorID sprite, PaletteID pal)
	Assign a single non-animated sprite to the cursor. More...

void	SetAnimatedMouseCursor (const AnimCursor *table)
	Assign an animation to the cursor. More...

bool	ChangeResInGame (int width, int height)

bool	ToggleFullScreen (bool fs)

void	SortResolutions ()

void	UpdateGUIZoom ()
	Resolve GUI zoom level, if auto-suggestion is requested.

bool	AdjustGUIZoom (bool automatic)
	Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested. More...

void	ChangeGameSpeed (bool enable_fast_forward)

Variables
uint8_t	_dirkeys
	1 = left, 2 = up, 4 = right, 8 = down

bool	_fullscreen

uint8_t	_support8bpp

CursorVars	_cursor

bool	_ctrl_pressed
	Is Ctrl pressed?

bool	_shift_pressed
	Is Shift pressed?

uint16_t	_game_speed = 100
	Current game-speed; 100 is 1x, 0 is infinite.

bool	_left_button_down
	Is left mouse button pressed?

bool	_left_button_clicked
	Is left mouse button clicked?

bool	_right_button_down
	Is right mouse button pressed?

bool	_right_button_clicked
	Is right mouse button clicked?

DrawPixelInfo	_screen

bool	_screen_disable_anim = false
	Disable palette animation (important for 32bpp-anim blitter during giant screenshot)

std::atomic< bool >	_exit_game

GameMode	_game_mode

SwitchMode	_switch_mode
	The next mainloop command.

PauseMode	_pause_mode
	The current pause mode.

GameSessionStats	_game_session_stats
	Statistics about the current session.

static uint8_t	_stringwidth_table [FS_END][224]
	Cache containing width of often used characters. More...

DrawPixelInfo *	_cur_dpi

static ReusableBuffer< uint8_t >	_cursor_backup

ZoomLevel	_gui_zoom = ZOOM_LVL_NORMAL
	GUI Zoom level.

ZoomLevel	_font_zoom = _gui_zoom
	Sprite font Zoom level (not clamped)

int	_gui_scale = MIN_INTERFACE_SCALE
	GUI scale, 100 is 100%.

int	_gui_scale_cfg
	GUI scale in config.

static Rect	_invalid_rect
	The rect for repaint. More...

static const uint8_t *	_colour_remap_ptr

static uint8_t	_string_colourremap [3]
	Recoloursprite for stringdrawing. The grf loader ensures that SpriteType::Font sprites only use colours 0 to 2.

static const uint	DIRTY_BLOCK_HEIGHT = 8

static const uint	DIRTY_BLOCK_WIDTH = 64

static uint	_dirty_bytes_per_line = 0

static uint8_t *	_dirty_blocks = nullptr

uint	_dirty_block_colour

Detailed Description

Handling of drawing text and other gfx related stuff.

Definition in file gfx.cpp.

Function Documentation

◆ AdjustGUIZoom()

bool AdjustGUIZoom ( bool automatic )

Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.

Parameters

automatic Set if the change is occuring due to OS DPI scaling being changed.

Returns: true when the zoom level has changed, caller must call ReInitAllWindows(true) after resizing the application's window/buffer.

Definition at line 1793 of file gfx.cpp.

References _font_zoom, _gui_scale, _gui_zoom, VideoDriver::ClearSystemSprites(), VideoDriver::GetInstance(), GfxClearFontSpriteCache(), UpdateCursorSize(), and UpdateGUIZoom().

Referenced by GameOptionsWindow::OnMouseLoop().

◆ 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.

This can be used to draw boxes in world coordinates.

Parameters

x	Screen X-coordinate of top front corner.
y	Screen Y-coordinate of top front corner.
dx1	Screen X-length of first edge.
dy1	Screen Y-length of first edge.
dx2	Screen X-length of second edge.
dy2	Screen Y-length of second edge.
dx3	Screen X-length of third edge.
dy3	Screen Y-length of third edge.

Definition at line 418 of file gfx.cpp.

Referenced by ViewportDrawBoundingBoxes().

◆ DrawCharCentered()

void DrawCharCentered	(	char32_t	c,
		const Rect &	r,
		TextColour	colour
	)

Draw single character horizontally centered around (x,y)

Parameters

c	Character (glyph) to draw
r	Rectangle to draw character within
colour	Colour to use, for details see _string_colourmap in table/palettes.h or docs/ottd-colourtext-palette.png or the enum TextColour in gfx_type.h

Definition at line 905 of file gfx.cpp.

References SetColourRemap().

◆ DrawLayoutLine()

static int DrawLayoutLine	(	const ParagraphLayouter::Line &	line,
		int	y,
		int	left,
		int	right,
		StringAlignment	align,
		bool	underline,
		bool	truncation,
		TextColour	default_colour
	)

static

Drawing routine for drawing a laid out line of text.

Parameters

line	String to draw.
y	The top most position to draw on.
left	The left most position to draw on.
right	The right most position to draw on.
align	The alignment of the string when drawing left-to-right. In the case a right-to-left language is chosen this is inverted so it will be drawn in the right direction.
underline	Whether to underline what has been drawn or not.
truncation	Whether to perform string truncation or not.
default_colour	Colour of text if not specified within string.

Returns: In case of left or center alignment the right most pixel we have drawn to. In case of right alignment the left most pixel we have drawn to.

Definition at line 499 of file gfx.cpp.

◆ DrawRectOutline()

void DrawRectOutline	(	const Rect &	r,
		int	colour,
		int	width,
		int	dash
	)

Draw the outline of a Rect.

Parameters

r	Rect to draw.
colour	Colour of the outline.
width	Width of the outline.
dash	Length of dashes for dashed lines. 0 means solid lines.

Definition at line 456 of file gfx.cpp.

◆ DrawSprite()

void DrawSprite	(	SpriteID	img,
		PaletteID	pal,
		int	x,
		int	y,
		const SubSprite *	sub,
		ZoomLevel	zoom
	)

Draw a sprite, not in a viewport.

Parameters

img	Image number to draw
pal	Palette to use.
x	Left coordinate of image in pixels
y	Top coordinate of image in pixels
sub	If available, draw only specified part of the sprite
zoom	Zoom level of sprite

Definition at line 988 of file gfx.cpp.

Referenced by StoryBookWindow::DrawActionElement().

◆ DrawSpriteToRgbaBuffer()

std::unique_ptr<uint32_t[]> DrawSpriteToRgbaBuffer	(	SpriteID	spriteId,
		ZoomLevel	zoom
	)

Draws a sprite to a new RGBA buffer (see Colour union) instead of drawing to the screen.

Parameters

spriteId	The sprite to draw.
zoom	The zoom level at which to draw the sprites.

Returns: Pixel buffer, or nullptr if an 8bpp blitter is being used.

Definition at line 1144 of file gfx.cpp.

References _settings_client, GB(), BlitterFactory::GetCurrentBlitter(), Blitter::GetScreenDepth(), ClientSettings::gui, SPRITE_WIDTH, and GUISettings::zoom_max.

◆ DrawSpriteViewport()

void DrawSpriteViewport	(	SpriteID	img,
		PaletteID	pal,
		int	x,
		int	y,
		const SubSprite *	sub
	)

Draw a sprite in a viewport.

Parameters

img	Image number to draw
pal	Palette to use.
x	Left coordinate of image in viewport, scaled by zoom
y	Top coordinate of image in viewport, scaled by zoom
sub	If available, draw only specified part of the sprite

Definition at line 960 of file gfx.cpp.

◆ DrawString() [1/2]

int DrawString	(	int	left,
		int	right,
		int	top,
		std::string_view	str,
		TextColour	colour,
		StringAlignment	align,
		bool	underline,
		FontSize	fontsize
	)

Draw string, possibly truncated to make it fit in its allocated space.

Parameters

left	The left most position to draw on.
right	The right most position to draw on.
top	The top most position to draw on.
str	String to draw.
colour	Colour used for drawing the string, for details see _string_colourmap in table/palettes.h or docs/ottd-colourtext-palette.png or the enum TextColour in gfx_type.h
align	The alignment of the string when drawing left-to-right. In the case a right-to-left language is chosen this is inverted so it will be drawn in the right direction.
underline	Whether to underline what has been drawn or not.
fontsize	The size of the initial characters.

Returns: In case of left or center alignment the right most pixel we have drawn to. In case of right alignment the left most pixel we have drawn to.

Definition at line 657 of file gfx.cpp.

References FS_LARGE, FS_MONO, FS_NORMAL, FS_SMALL, and GetCharacterHeight().

Referenced by CargoesField::Draw(), TownAuthorityWindow::DrawActions(), StationViewWindow::DrawCargoRatings(), DrawCategory(), NetworkContentListWindow::DrawDetails(), DrawFrame(), IndustryViewWindow::DrawInfo(), DrawInset(), GoalListWindow::DrawListColumn(), DrawPrice(), TownAuthorityWindow::DrawRatings(), DrawString(), TimetableWindow::DrawSummaryPanel(), and DrawText().

◆ DrawString() [2/2]

int DrawString	(	int	left,
		int	right,
		int	top,
		StringID	str,
		TextColour	colour,
		StringAlignment	align,
		bool	underline,
		FontSize	fontsize
	)

Draw string, possibly truncated to make it fit in its allocated space.

Parameters

left	The left most position to draw on.
right	The right most position to draw on.
top	The top most position to draw on.
str	String to draw.
colour	Colour used for drawing the string, for details see _string_colourmap in table/palettes.h or docs/ottd-colourtext-palette.png or the enum TextColour in gfx_type.h
align	The alignment of the string when drawing left-to-right. In the case a right-to-left language is chosen this is inverted so it will be drawn in the right direction.
underline	Whether to underline what has been drawn or not.
fontsize	The size of the initial characters.

Returns: In case of left or center alignment the right most pixel we have drawn to. In case of right alignment the left most pixel we have drawn to.

Definition at line 693 of file gfx.cpp.

References DrawString(), and GetString().

◆ DrawStringMultiLine() [1/2]

int DrawStringMultiLine	(	int	left,
		int	right,
		int	top,
		int	bottom,
		std::string_view	str,
		TextColour	colour,
		StringAlignment	align,
		bool	underline,
		FontSize	fontsize
	)

Draw string, possibly over multiple lines.

Parameters

left	The left most position to draw on.
right	The right most position to draw on.
top	The top most position to draw on.
bottom	The bottom most position to draw on.
str	String to draw.
colour	Colour used for drawing the string, for details see _string_colourmap in table/palettes.h or docs/ottd-colourtext-palette.png or the enum TextColour in gfx_type.h
align	The horizontal and vertical alignment of the string.
underline	Whether to underline all strings
fontsize	The size of the initial characters.

Returns: If align is SA_BOTTOM, the top to where we have written, else the bottom to where we have written.

Definition at line 774 of file gfx.cpp.

References Layouter::GetBounds().

Referenced by StationViewWindow::DrawAcceptedCargo(), StationViewWindow::DrawCargoRatings(), DrawStringMultiLine(), IConsoleWindow::OnPaint(), and HighScoreWindow::OnPaint().

◆ DrawStringMultiLine() [2/2]

int DrawStringMultiLine	(	int	left,
		int	right,
		int	top,
		int	bottom,
		StringID	str,
		TextColour	colour,
		StringAlignment	align,
		bool	underline,
		FontSize	fontsize
	)

Draw string, possibly over multiple lines.

Parameters

left	The left most position to draw on.
right	The right most position to draw on.
top	The top most position to draw on.
bottom	The bottom most position to draw on.
str	String to draw.
colour	Colour used for drawing the string, for details see _string_colourmap in table/palettes.h or docs/ottd-colourtext-palette.png or the enum TextColour in gfx_type.h
align	The horizontal and vertical alignment of the string.
underline	Whether to underline all strings
fontsize	The size of the initial characters.

Returns: If align is SA_BOTTOM, the top to where we have written, else the bottom to where we have written.

Definition at line 836 of file gfx.cpp.

References DrawStringMultiLine(), and GetString().

◆ 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.

To do this, Fill a DrawPixelInfo object with the supplied relative rectangle, backup the original (calling) _cur_dpi and assign the just returned DrawPixelInfo _cur_dpi. When you are done, give restore _cur_dpi's original value

Parameters

*n	the DrawPixelInfo that will be the clipping rectangle box allowed for drawing
left,top,width,height	the relative coordinates of the clipping rectangle relative to the current _cur_dpi. This will most likely be the offset from the calling window coordinates

Returns: return false if the requested rectangle is not possible with the current dpi pointer. Only continue of the return value is true, or you'll get some nasty results

Definition at line 1548 of file gfx.cpp.

References BlitterFactory::GetCurrentBlitter().

Referenced by NWidgetLeaf::Draw(), DrawRoadVehImage(), DrawTrainImage(), and ScriptDebugWindow::DrawWidgetLog().

◆ GetBlitterMode()

static BlitterMode GetBlitterMode ( PaletteID pal )

static

Helper function to get the blitter mode for different types of palettes.

Parameters

pal	The palette to get the blitter mode for.

Returns: The blitter mode associated with the palette.

Definition at line 942 of file gfx.cpp.

◆ GetBroadestDigit()

void GetBroadestDigit	(	uint *	front,
		uint *	next,
		FontSize	size
	)

Determine the broadest digits for guessing the maximum width of a n-digit number.

Parameters

[out]	front	Broadest digit, which is not 0. (Use this digit as first digit for numbers with more than one digit.)
[out]	next	Broadest digit, including 0. (Use this digit for all digits, except the first one; or for numbers with only one digit.)
	size	Font of the digit

Definition at line 1255 of file gfx.cpp.

References GetCharacterWidth().

Referenced by SetDParamMaxDigits().

◆ GetCharacterWidth()

uint8_t GetCharacterWidth	(	FontSize	size,
		char32_t	key
	)

Return width of character glyph.

Parameters

size	Font of the character
key	Character code glyph

Returns: Width of the character glyph

Definition at line 1227 of file gfx.cpp.

References _stringwidth_table, and GetGlyphWidth().

Referenced by GetBroadestDigit(), GetDigitWidth(), and IConsoleWindow::OnInit().

◆ GetDigitWidth()

uint8_t GetDigitWidth ( FontSize size )

Return the maximum width of single digit.

Parameters

size	Font of the digit

Returns: Width of the digit.

Definition at line 1240 of file gfx.cpp.

References GetCharacterWidth().

◆ GetSpriteSize()

Dimension GetSpriteSize	(	SpriteID	sprid,
		Point *	offset,
		ZoomLevel	zoom
	)

Get the size of a sprite.

Parameters

	sprid	Sprite to examine.
[out]	offset	Optionally returns the sprite position offset.
	zoom	The zoom level applicable to the sprite.

Returns: Sprite size in pixels.

Note: The size assumes (0, 0) as top-left coordinate and ignores any part of the sprite drawn at the left or above that position.

Definition at line 922 of file gfx.cpp.

Referenced by VehicleGroupWindow::ComputeGroupInfoSize(), StoryBookWindow::DrawActionElement(), NetworkClientListWindow::DrawCompany(), DrawCompanyManagerFace(), BuildSignalWindow::DrawSignalSprite(), TimetableWindow::DrawTimetablePanel(), BaseVehicleListWindow::DrawVehicleListItems(), DrawVehicleRefitWindow(), GetLargestCargoIconSize(), StoryBookWindow::GetPageElementHeight(), GetScaledSpriteSize(), MakeCompanyButtonRows(), MakeNWidgetCompanyLines(), CheatWindow::OnInit(), SelectCompanyManagerFaceWindow::OnInit(), GameSettingsWindow::OnInit(), and TownAuthorityWindow::OnInit().

◆ GetStringBoundingBox() [1/2]

Dimension GetStringBoundingBox	(	std::string_view	str,
		FontSize	start_fontsize
	)

Return the string dimension in pixels.

The height and width are returned in a single Dimension value. TINYFONT, BIGFONT modifiers are only supported as the first character of the string. The returned dimensions are therefore a rough estimation correct for all the current strings but not every possible combination

Parameters

str	string to calculate pixel-width
start_fontsize	Fontsize to start the text with

Returns: string width and height in pixels

Definition at line 851 of file gfx.cpp.

References Layouter::GetBounds().

Referenced by DrawText(), TimetableWindow::DrawTimetablePanel(), BaseVehicleListWindow::GetActionDropdownSize(), IndustryDirectoryWindow::GetIndustryListWidth(), ExpensesList::GetListWidth(), GetMaxCategoriesWidth(), StoryBookWindow::GetPageElementFloatWidth(), StoryBookWindow::GetPageElementHeight(), GetStringBoundingBox(), GetStringListBoundingBox(), GetStringListWidth(), GetUnitNumberWidth(), BaseGraphWindow::GetYLabelWidth(), TextfileWindow::LoadText(), SelectCompanyManagerFaceWindow::OnInit(), IConsoleWindow::OnInit(), IndustryCargoesWindow::OnInit(), BaseVehicleListWindow::OnInit(), ScriptDebugWindow::OnInvalidateData(), RefitWindow::OnInvalidateData(), GoalListWindow::OnPaint(), NWidgetBackground::SetupSmallestSize(), ViewportSign::UpdatePosition(), and Textbuf::UpdateWidth().

◆ GetStringBoundingBox() [2/2]

Dimension GetStringBoundingBox	(	StringID	strid,
		FontSize	start_fontsize
	)

Get bounding box of a string.

Uses parameters set by SetDParam if needed. Has the same restrictions as GetStringBoundingBox(std::string_view str, FontSize start_fontsize).

Parameters

strid String to examine.

Returns: Width and height of the bounding box for the string in pixels.

Definition at line 863 of file gfx.cpp.

References GetString(), and GetStringBoundingBox().

◆ GetStringHeight() [1/2]

int GetStringHeight	(	std::string_view	str,
		int	maxw,
		FontSize	fontsize
	)

Calculates height of string (in pixels).

The string is changed to a multiline string if needed.

Parameters

str	string to check
maxw	maximum string width

Returns: height of pixels of string when it is drawn

Definition at line 704 of file gfx.cpp.

References Layouter::GetBounds().

Referenced by StoryBookWindow::GetHeadHeight(), SettingEntry::GetMaxHelpHeight(), StoryBookWindow::GetPageElementHeight(), GetStringHeight(), and TextfileWindow::ReflowContent().

◆ GetStringHeight() [2/2]

int GetStringHeight	(	StringID	str,
		int	maxw
	)

Calculates height of string (in pixels).

The string is changed to a multiline string if needed.

Parameters

str	string to check
maxw	maximum string width

Returns: height of pixels of string when it is drawn

Definition at line 717 of file gfx.cpp.

References GetString(), and GetStringHeight().

◆ GetStringLineCount()

int GetStringLineCount	(	StringID	str,
		int	maxw
	)

Calculates number of lines of string.

The string is changed to a multiline string if needed.

Parameters

str	string to check
maxw	maximum string width

Returns: number of lines of string when it is drawn

Definition at line 728 of file gfx.cpp.

References GetString().

◆ GetStringListBoundingBox()

Dimension GetStringListBoundingBox	(	std::span< const StringID >	list,
		FontSize	fontsize
	)

Get maximum dimension of a list of strings.

Parameters

list	List of strings, terminated by INVALID_STRING_ID.
fontsize	Font size to use.

Returns: Dimension of highest and longest string within the list.

Definition at line 889 of file gfx.cpp.

References GetStringBoundingBox(), and maxdim().

◆ GetStringListWidth()

uint GetStringListWidth	(	std::span< const StringID >	list,
		FontSize	fontsize
	)

Get maximum width of a list of strings.

Parameters

list	List of strings.
fontsize	Font size to use.

Returns: Width of longest string within the list.

Definition at line 874 of file gfx.cpp.

References GetStringBoundingBox().

◆ GetStringMultiLineBoundingBox() [1/2]

Dimension GetStringMultiLineBoundingBox	(	std::string_view	str,
		const Dimension &	suggestion
	)

Calculate string bounding box for multi-line strings.

Parameters

str	String to check.
suggestion	Suggested bounding box.

Returns: Bounding box for the multi-line string, may be bigger than suggestion.

Definition at line 752 of file gfx.cpp.

◆ GetStringMultiLineBoundingBox() [2/2]

Dimension GetStringMultiLineBoundingBox	(	StringID	str,
		const Dimension &	suggestion
	)

Calculate string bounding box for multi-line strings.

Parameters

str	String to check.
suggestion	Suggested bounding box.

Returns: Bounding box for the multi-line string, may be bigger than suggestion.

Definition at line 740 of file gfx.cpp.

◆ GfxBlitter()

template<int ZOOM_BASE, bool SCALED_XY>

static void GfxBlitter	(	const Sprite *const	sprite,
		int	x,
		int	y,
		BlitterMode	mode,
		const SubSprite *const	sub,
		SpriteID	sprite_id,
		ZoomLevel	zoom,
		const DrawPixelInfo *	dst = `nullptr`
	)

static

The code for setting up the blitter mode and sprite information before finally drawing the sprite.

Parameters

sprite	The sprite to draw.
x	The X location to draw.
y	The Y location to draw.
mode	The settings for the blitter to pass.
sub	Whether to only draw a sub set of the sprite.
zoom	The zoom level at which to draw the sprites.
dst	Optional parameter for a different blitting destination.

Template Parameters

ZOOM_BASE	The factor required to get the sub sprite information into the right size.
SCALED_XY	Whether the X and Y are scaled or unscaled.

Definition at line 1020 of file gfx.cpp.

◆ GfxDoDrawLine()

static void GfxDoDrawLine	(	void *	video,
		int	x,
		int	y,
		int	x2,
		int	y2,
		int	screen_width,
		int	screen_height,
		uint8_t	colour,
		int	width,
		int	dash = `0`
	)

inlinestatic

Check line clipping by using a linear equation and draw the visible part of the line given by x/y and x2/y2.

Parameters

video	Destination pointer to draw into.
x	X coordinate of first point.
y	Y coordinate of first point.
x2	X coordinate of second point.
y2	Y coordinate of second point.
screen_width	With of the screen to check clipping against.
screen_height	Height of the screen to check clipping against.
colour	Colour of the line.
width	Width of the line.
dash	Length of dashes for dashed lines. 0 means solid line.

Definition at line 313 of file gfx.cpp.

◆ GfxFillPolygon()

void GfxFillPolygon	(	const std::vector< Point > &	shape,
		int	colour,
		FillRectMode	mode
	)

Fill a polygon with colour.

The odd-even winding rule is used, i.e. self-intersecting polygons will have holes in them. Left and top edges are inclusive, right and bottom edges are exclusive.

Note: For rectangles the GfxFillRect function will be faster.

Precondition: dpi->zoom == ZOOM_LVL_MIN

Parameters

shape	List of points on the polygon.
colour	An 8 bit palette index (FILLRECT_OPAQUE and FILLRECT_CHECKER) or a recolour spritenumber (FILLRECT_RECOLOUR).
mode	FILLRECT_OPAQUE: Fill the polygon with the specified colour. FILLRECT_CHECKER: Fill every other pixel with the specified colour, in a checkerboard pattern. FILLRECT_RECOLOUR: Apply a recolour sprite to every pixel in the polygon.

Definition at line 210 of file gfx.cpp.

References BlitterFactory::GetCurrentBlitter().

◆ GfxFillRect()

void GfxFillRect	(	int	left,
		int	top,
		int	right,
		int	bottom,
		int	colour,
		FillRectMode	mode
	)

Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.

Precondition: dpi->zoom == ZOOM_LVL_MIN, right >= left, bottom >= top

Parameters

left	Minimum X (inclusive)
top	Minimum Y (inclusive)
right	Maximum X (inclusive)
bottom	Maximum Y (inclusive)
colour	A 8 bit palette index (FILLRECT_OPAQUE and FILLRECT_CHECKER) or a recolour spritenumber (FILLRECT_RECOLOUR)
mode	FILLRECT_OPAQUE: Fill the rectangle with the specified colour FILLRECT_CHECKER: Like FILLRECT_OPAQUE, but only draw every second pixel (used to grey out things) FILLRECT_RECOLOUR: Apply a recolour sprite to every pixel in the rectangle currently on screen

Definition at line 114 of file gfx.cpp.

References BlitterFactory::GetCurrentBlitter().

Referenced by NWidgetToolbarContainer::Draw(), NWidgetMatrix::Draw(), NWidgetViewport::Draw(), DrawCaption(), NetworkContentListWindow::DrawDetails(), NetworkContentListWindow::DrawMatrix(), and IConsoleWindow::OnPaint().

◆ GfxPreprocessLine()

static bool GfxPreprocessLine	(	DrawPixelInfo *	dpi,
		int &	x,
		int &	y,
		int &	x2,
		int &	y2,
		int	width
	)

inlinestatic

Align parameters of a line to the given DPI and check simple clipping.

Parameters

dpi	Screen parameters to align with.
x	X coordinate of first point.
y	Y coordinate of first point.
x2	X coordinate of second point.
y2	Y coordinate of second point.
width	Width of the line.

Returns: True if the line is likely to be visible, false if it's certainly invisible.

Definition at line 371 of file gfx.cpp.

◆ LoadStringWidthTable()

void LoadStringWidthTable ( bool monospace )

Initialize _stringwidth_table cache.

Parameters

monospace Whether to load the monospace cache or the normal fonts.

Definition at line 1210 of file gfx.cpp.

Referenced by ReloadNewGRFData().

◆ MakePolygonSegments()

static std::vector<LineSegment> MakePolygonSegments	(	const std::vector< Point > &	shape,
		Point	offset
	)

static

Make line segments from a polygon defined by points, translated by an offset.

Entirely horizontal lines (start and end at same Y coordinate) are skipped, as they are irrelevant to scanline conversion algorithms. Generated line segments always have the lowest Y coordinate point first, i.e. original direction is lost.

Parameters

shape	The polygon to convert.
offset	Offset vector subtracted from all coordinates in the shape.

Returns: Vector of undirected line segments.

Definition at line 171 of file gfx.cpp.

◆ SetAnimatedMouseCursor()

void SetAnimatedMouseCursor ( const AnimCursor * table )

Assign an animation to the cursor.

Parameters

table Array of animation states.

See also: SetMouseCursor

Definition at line 1699 of file gfx.cpp.

◆ SetColourRemap()

static void SetColourRemap ( TextColour colour )

static

Set the colour remap to be for the given colour.

Parameters

colour the new colour of the remap.

Definition at line 468 of file gfx.cpp.

Referenced by DrawCharCentered().

◆ SetCursorSprite()

static void SetCursorSprite	(	CursorID	cursor,
		PaletteID	pal
	)

static

Switch cursor to different sprite.

Parameters

cursor	Sprite to draw for the cursor.
pal	Palette to use for recolouring.

Definition at line 1636 of file gfx.cpp.

◆ SetMouseCursor()

void SetMouseCursor	(	CursorID	sprite,
		PaletteID	pal
	)

Assign a single non-animated sprite to the cursor.

Parameters

sprite	Sprite to draw for the cursor.
pal	Palette to use for recolouring.

See also: SetAnimatedMouseCursor

Definition at line 1686 of file gfx.cpp.

◆ SetMouseCursorBusy()

void SetMouseCursorBusy ( bool busy )

Set or unset the ZZZ cursor.

Parameters

busy	Whether to show the ZZZ cursor.

Definition at line 1670 of file gfx.cpp.

Referenced by CleanupGeneration(), SaveFileDone(), and SaveFileStart().

◆ UpdateCursorSize()

void UpdateCursorSize ( )

Update cursor dimension.

Called when changing cursor sprite resp. reloading grfs.

Definition at line 1598 of file gfx.cpp.

References GetMaxSpriteID().

Referenced by AdjustGUIZoom().

Variable Documentation

◆ _stringwidth_table

uint8_t _stringwidth_table[FS_END][224]

static

Cache containing width of often used characters.

See also: GetCharacterWidth()

Definition at line 53 of file gfx.cpp.

Referenced by GetCharacterWidth().

Typedefs

Functions

Variables

Detailed Description

Function Documentation

◆ AdjustGUIZoom()

◆ DrawBox()

◆ DrawCharCentered()

◆ DrawLayoutLine()

◆ DrawRectOutline()

◆ DrawSprite()

◆ DrawSpriteToRgbaBuffer()

◆ DrawSpriteViewport()

◆ DrawString() [1/2]

◆ DrawString() [2/2]

◆ DrawStringMultiLine() [1/2]

◆ DrawStringMultiLine() [2/2]

◆ FillDrawPixelInfo()

◆ GetBlitterMode()

◆ GetBroadestDigit()

◆ GetCharacterWidth()

◆ GetDigitWidth()

◆ GetSpriteSize()

◆ GetStringBoundingBox() [1/2]

◆ GetStringBoundingBox() [2/2]

◆ GetStringHeight() [1/2]

◆ GetStringHeight() [2/2]

◆ GetStringLineCount()

◆ GetStringListBoundingBox()

◆ GetStringListWidth()

◆ GetStringMultiLineBoundingBox() [1/2]

◆ GetStringMultiLineBoundingBox() [2/2]

◆ GfxBlitter()

◆ GfxDoDrawLine()

◆ GfxFillPolygon()

◆ GfxFillRect()

◆ GfxPreprocessLine()

◆ LoadStringWidthTable()

◆ MakePolygonSegments()

◆ SetAnimatedMouseCursor()

◆ SetColourRemap()

◆ SetCursorSprite()

◆ SetMouseCursor()

◆ SetMouseCursorBusy()

◆ UpdateCursorSize()

Variable Documentation

◆ _stringwidth_table