OpenTTD
Macros | Enumerations | Functions | Variables
gfx_func.h File Reference

Functions related to the gfx engine. More...

#include "gfx_type.h"
#include "strings_type.h"
#include "string_type.h"

Go to the source code of this file.

Macros

#define FONT_HEIGHT_SMALL   (GetCharacterHeight(FS_SMALL))
 Height of characters in the small (FS_SMALL) font. More...
 
#define FONT_HEIGHT_NORMAL   (GetCharacterHeight(FS_NORMAL))
 Height of characters in the normal (FS_NORMAL) font. More...
 
#define FONT_HEIGHT_LARGE   (GetCharacterHeight(FS_LARGE))
 Height of characters in the large (FS_LARGE) font. More...
 
#define FONT_HEIGHT_MONO   (GetCharacterHeight(FS_MONO))
 Height of characters in the large (FS_MONO) font. More...
 
#define GREY_SCALE(level)   (level)
 Return the colour for a particular greyscale level. More...
 

Enumerations

enum  StringAlignment {
  SA_LEFT = 0 << 0, SA_HOR_CENTER = 1 << 0, SA_RIGHT = 2 << 0, SA_HOR_MASK = 3 << 0,
  SA_TOP = 0 << 2, SA_VERT_CENTER = 1 << 2, SA_BOTTOM = 2 << 2, SA_VERT_MASK = 3 << 2,
  SA_CENTER = SA_HOR_CENTER | SA_VERT_CENTER, SA_FORCE = 1 << 4
}
 How to align the to-be drawn text. More...
 

Functions

void GameLoop ()
 
void CreateConsole ()
 
void HandleKeypress (uint keycode, WChar key)
 Handle keyboard input. More...
 
void HandleTextInput (const char *str, bool marked=false, const char *caret=NULL, const char *insert_location=NULL, const char *replacement_end=NULL)
 Handle text input. More...
 
void HandleCtrlChanged ()
 State of CONTROL key has changed.
 
void HandleMouseEvents ()
 Handle a mouse event from the video driver.
 
void CSleep (int milliseconds)
 
void UpdateWindows ()
 Update the continuously changing contents of the windows, such as the viewports.
 
void DrawMouseCursor ()
 
void ScreenSizeChanged ()
 
void GameSizeChanged ()
 Size of the application screen changed. More...
 
void UndrawMouseCursor ()
 
void RedrawScreenRect (int left, int top, int right, int bottom)
 
void GfxScroll (int left, int top, int width, int height, int xo, int yo)
 
Dimension GetSpriteSize (SpriteID sprid, Point *offset=NULL, ZoomLevel zoom=ZOOM_LVL_GUI)
 Get the size of a sprite. More...
 
void DrawSpriteViewport (SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub=NULL)
 Draw a sprite in a viewport. More...
 
void DrawSprite (SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub=NULL, ZoomLevel zoom=ZOOM_LVL_GUI)
 Draw a sprite, not in a viewport. More...
 
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. More...
 
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)
 Draw string, possibly truncated to make it fit in its allocated space. More...
 
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. More...
 
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)
 Draw string, possibly over multiple lines. More...
 
void DrawCharCentered (uint32 c, int x, int y, TextColour colour)
 Draw single character horizontally centered around (x,y) More...
 
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. More...
 
void GfxDrawLine (int left, int top, int right, int bottom, int colour, int width=1, int dash=0)
 
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...
 
Dimension GetStringBoundingBox (const char *str, FontSize start_fontsize=FS_NORMAL)
 Return the string dimension in pixels. More...
 
Dimension GetStringBoundingBox (StringID strid)
 Get bounding box of a string. More...
 
int GetStringHeight (const char *str, int maxw, FontSize fontsize=FS_NORMAL)
 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 (const char *str, const Dimension &suggestion)
 Calculate string bounding box for multi-line strings. More...
 
void LoadStringWidthTable (bool monospace=false)
 Initialize _stringwidth_table cache. More...
 
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. More...
 
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. More...
 
void DrawDirtyBlocks ()
 Repaints the rectangle blocks which are marked as 'dirty'. More...
 
void SetDirtyBlocks (int left, int top, int right, int bottom)
 This function extends the internal _invalid_rect rectangle as it now contains the rectangle defined by the given parameters. More...
 
void MarkWholeScreenDirty ()
 This function mark the whole screen as dirty. More...
 
void GfxInitPalettes ()
 
void CheckBlitter ()
 Check whether we still use the right blitter, or use another (better) one. 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...
 
static int CenterBounds (int min, int max, int size)
 Determine where to draw a centred object inside a widget. More...
 
void DrawOverlappedWindowForAll (int left, int top, int right, int bottom)
 From a rectangle that needs redrawing, find the windows that intersect with the rectangle. More...
 
void SetMouseCursorBusy (bool busy)
 Set or unset the ZZZ cursor. More...
 
void SetMouseCursor (CursorID cursor, PaletteID pal)
 Assign a single non-animated sprite to the cursor. More...
 
void SetAnimatedMouseCursor (const AnimCursor *table)
 Assign an animation to the cursor. More...
 
void CursorTick ()
 
void UpdateCursorSize ()
 Update cursor dimension. More...
 
bool ChangeResInGame (int w, int h)
 
void SortResolutions (int count)
 
bool ToggleFullScreen (bool fs)
 
byte GetCharacterWidth (FontSize size, uint32 key)
 Return width of character glyph. More...
 
byte GetDigitWidth (FontSize size=FS_NORMAL)
 Return the maximum width of single digit. More...
 
void GetBroadestDigit (uint *front, uint *next, FontSize size=FS_NORMAL)
 Determine the broadest digits for guessing the maximum width of a n-digit number. More...
 
int GetCharacterHeight (FontSize size)
 Get height of a character for a given font size. More...
 
TextColour GetContrastColour (uint8 background)
 Determine a contrasty text colour for a coloured background. More...
 

Variables

byte _dirkeys
 1 = left, 2 = up, 4 = right, 8 = down
 
bool _fullscreen
 
byte _support8bpp
 
CursorVars _cursor
 
bool _ctrl_pressed
 Is Ctrl pressed?
 
bool _shift_pressed
 Is Shift pressed?
 
byte _fast_forward
 
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
 Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
 
int _num_resolutions
 The number of resolutions.
 
Dimension _resolutions [32]
 List of resolutions.
 
Dimension _cur_resolution
 The current resolution.
 
Palette _cur_palette
 Current palette.
 
static const int DRAW_STRING_BUFFER = 2048
 Size of the buffer used for drawing strings. More...
 
DrawPixelInfo_cur_dpi
 
byte _colour_gradient [COLOUR_END][8]
 All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
 
bool _palette_remap_grf []
 Whether the given NewGRFs must get a palette remap from windows to DOS or not. More...
 
static const uint8 PC_BLACK = GREY_SCALE(1)
 Black palette colour.
 
static const uint8 PC_DARK_GREY = GREY_SCALE(6)
 Dark grey palette colour.
 
static const uint8 PC_GREY = GREY_SCALE(10)
 Grey palette colour.
 
static const uint8 PC_WHITE = GREY_SCALE(15)
 White palette colour.
 
static const uint8 PC_VERY_DARK_RED = 0xB2
 Almost-black red palette colour.
 
static const uint8 PC_DARK_RED = 0xB4
 Dark red palette colour.
 
static const uint8 PC_RED = 0xB8
 Red palette colour.
 
static const uint8 PC_VERY_DARK_BROWN = 0x56
 Almost-black brown palette colour.
 
static const uint8 PC_ORANGE = 0xC2
 Orange palette colour.
 
static const uint8 PC_YELLOW = 0xBF
 Yellow palette colour.
 
static const uint8 PC_LIGHT_YELLOW = 0x44
 Light yellow palette colour.
 
static const uint8 PC_VERY_LIGHT_YELLOW = 0x45
 Almost-white yellow palette colour.
 
static const uint8 PC_GREEN = 0xD0
 Green palette colour.
 
static const uint8 PC_DARK_BLUE = 0x9D
 Dark blue palette colour.
 
static const uint8 PC_LIGHT_BLUE = 0x98
 Light blue palette colour.
 

Detailed Description

Functions related to the gfx engine.

Definition in file gfx_func.h.

Macro Definition Documentation

◆ FONT_HEIGHT_LARGE

#define FONT_HEIGHT_LARGE   (GetCharacterHeight(FS_LARGE))

Height of characters in the large (FS_LARGE) font.

Note
Some characters may be oversized.

Definition at line 183 of file gfx_func.h.

Referenced by DrawString().

◆ FONT_HEIGHT_MONO

#define FONT_HEIGHT_MONO   (GetCharacterHeight(FS_MONO))

Height of characters in the large (FS_MONO) font.

Note
Some characters may be oversized.

Definition at line 186 of file gfx_func.h.

Referenced by DrawString(), and TextfileWindow::SetupScrollbars().

◆ FONT_HEIGHT_NORMAL

#define FONT_HEIGHT_NORMAL   (GetCharacterHeight(FS_NORMAL))

Height of characters in the normal (FS_NORMAL) font.

Note
Some characters may be oversized.

Definition at line 180 of file gfx_func.h.

Referenced by CheckClickOnViewportSign(), CargoesField::Draw(), DrawButtonDropdown(), NetworkContentListWindow::DrawDetails(), DrawFrame(), NetworkContentListWindow::DrawMatrix(), DrawString(), CompanyLeagueWindow::DrawWidget(), NetworkClientListPopupWindow::DrawWidget(), NetworkClientListWindow::DrawWidget(), SavePresetWindow::DrawWidget(), ScenarioEditorToolbarWindow::DrawWidget(), StoryBookWindow::GetContentHeight(), TownViewWindow::GetDesiredInfoHeight(), GetEngineListHeight(), StoryBookWindow::GetHeadHeight(), TownAuthorityWindow::GetNthSetBit(), VehicleDetailsWindow::GetRoadVehDetailsHeight(), LocalGetWindowPlacement(), MakeAsdfgKeys(), MakeNumberKeys(), MakeQwertyKeys(), MakeSpacebarKeys(), MakeTopKeys(), MakeZxcvbKeys(), ViewportSign::MarkDirty(), NetworkReInitChatBoxSize(), CompanyStationsWindow::OnClick(), IndustryViewWindow::OnClick(), StationViewWindow::OnClick(), IndustryCargoesWindow::OnInit(), NetworkGameWindow::OnPaint(), ReplaceVehicleWindow::ReplaceClick_StartReplace(), SelectGameWindow::UpdateWidgetSize(), LandInfoWindow::UpdateWidgetSize(), AIListWindow::UpdateWidgetSize(), BuildObjectWindow::UpdateWidgetSize(), NewGRFParametersWindow::UpdateWidgetSize(), BuildAirportWindow::UpdateWidgetSize(), BuildIndustryWindow::UpdateWidgetSize(), CompanyStationsWindow::UpdateWidgetSize(), AISettingsWindow::UpdateWidgetSize(), VehicleGroupWindow::UpdateWidgetSize(), AboutWindow::UpdateWidgetSize(), SaveLoadWindow::UpdateWidgetSize(), NetworkContentListWindow::UpdateWidgetSize(), StoryBookWindow::UpdateWidgetSize(), RefitWindow::UpdateWidgetSize(), AIConfigWindow::UpdateWidgetSize(), OrdersWindow::UpdateWidgetSize(), SpriteAlignerWindow::UpdateWidgetSize(), MessageHistoryWindow::UpdateWidgetSize(), BuildRailStationWindow::UpdateWidgetSize(), AIDebugWindow::UpdateWidgetSize(), PerformanceRatingDetailWindow::UpdateWidgetSize(), StationViewWindow::UpdateWidgetSize(), NetworkLobbyWindow::UpdateWidgetSize(), GameSettingsWindow::UpdateWidgetSize(), VehicleDetailsWindow::UpdateWidgetSize(), NetworkJoinStatusWindow::UpdateWidgetSize(), SavePresetWindow::UpdateWidgetSize(), ScanProgressWindow::UpdateWidgetSize(), and ViewportAddString().

◆ FONT_HEIGHT_SMALL

#define FONT_HEIGHT_SMALL   (GetCharacterHeight(FS_SMALL))

Height of characters in the small (FS_SMALL) font.

Note
Some characters may be oversized.

Definition at line 177 of file gfx_func.h.

Referenced by CheckClickOnViewportSign(), DrawString(), SmallMapWindow::GetLegendHeight(), SmallMapWindow::GetPositionOnLegend(), GetVehicleListHeight(), and CompanyStationsWindow::UpdateWidgetSize().

◆ GREY_SCALE

#define GREY_SCALE (   level)    (level)

Return the colour for a particular greyscale level.

Parameters
levelIntensity, 0 = black, 15 = white
Returns
colour

Definition at line 205 of file gfx_func.h.

Enumeration Type Documentation

◆ StringAlignment

How to align the to-be drawn text.

Enumerator
SA_LEFT 

Left align the text.

SA_HOR_CENTER 

Horizontally center the text.

SA_RIGHT 

Right align the text (must be a single bit).

SA_HOR_MASK 

Mask for horizontal alignment.

SA_TOP 

Top align the text.

SA_VERT_CENTER 

Vertically center the text.

SA_BOTTOM 

Bottom align the text.

SA_VERT_MASK 

Mask for vertical alignment.

SA_CENTER 

Center both horizontally and vertically.

SA_FORCE 

Force the alignment, i.e. don't swap for RTL languages.

Definition at line 97 of file gfx_func.h.

Function Documentation

◆ CenterBounds()

static int CenterBounds ( int  min,
int  max,
int  size 
)
inlinestatic

Determine where to draw a centred object inside a widget.

Parameters
minThe top or left coordinate.
maxThe bottom or right coordinate.
sizeThe height or width of the object to draw.
Returns
Offset of where to start drawing the object.

Definition at line 152 of file gfx_func.h.

References DrawOverlappedWindowForAll(), SetAnimatedMouseCursor(), SetMouseCursor(), and SetMouseCursorBusy().

◆ CheckBlitter()

void CheckBlitter ( )

Check whether we still use the right blitter, or use another (better) one.

Definition at line 327 of file gfxinit.cpp.

References SwitchNewGRFBlitter().

◆ 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
xScreen X-coordinate of top front corner.
yScreen Y-coordinate of top front corner.
dx1Screen X-length of first edge.
dy1Screen Y-length of first edge.
dx2Screen X-length of second edge.
dy2Screen Y-length of second edge.
dx3Screen X-length of third edge.
dy3Screen Y-length of third edge.

Definition at line 278 of file gfx.cpp.

Referenced by ViewportDrawBoundingBoxes().

◆ DrawCharCentered()

void DrawCharCentered ( WChar  c,
int  x,
int  y,
TextColour  colour 
)

Draw single character horizontally centered around (x,y)

Parameters
cCharacter (glyph) to draw
xX position to draw character
yY position to draw character
colourColour to use, see DoDrawString() for details

Definition at line 755 of file gfx.cpp.

Referenced by OskWindow::DrawWidget().

◆ DrawDirtyBlocks()

void DrawDirtyBlocks ( )

Repaints the rectangle blocks which are marked as 'dirty'.

See also
SetDirtyBlocks

Definition at line 1307 of file gfx.cpp.

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

These windows should be re-painted.

Parameters
leftLeft edge of the rectangle that should be repainted
topTop edge of the rectangle that should be repainted
rightRight edge of the rectangle that should be repainted
bottomBottom edge of the rectangle that should be repainted

Definition at line 937 of file window.cpp.

Referenced by CenterBounds().

◆ DrawSprite()

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

Draw a sprite, not in a viewport.

Parameters
imgImage number to draw
palPalette to use.
xLeft coordinate of image in pixels
yTop coordinate of image in pixels
subIf available, draw only specified part of the sprite
zoomZoom level of sprite

Definition at line 833 of file gfx.cpp.

Referenced by StoryBookWindow::DrawActionElement(), TransparenciesWindow::DrawWidget(), and BuildTreesWindow::DrawWidget().

◆ DrawSpriteViewport()

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

Draw a sprite in a viewport.

Parameters
imgImage number to draw
palPalette to use.
xLeft coordinate of image in viewport, scaled by zoom
yTop coordinate of image in viewport, scaled by zoom
subIf available, draw only specified part of the sprite

Definition at line 806 of file gfx.cpp.

◆ DrawString() [1/2]

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

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

Parameters
leftThe left most position to draw on.
rightThe right most position to draw on.
topThe top most position to draw on.
strString to draw.
colourColour used for drawing the string, see DoDrawString() for details
alignThe 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.
underlineWhether to underline what has been drawn or not.
fontsizeThe 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 499 of file gfx.cpp.

References FONT_HEIGHT_LARGE, FONT_HEIGHT_MONO, FONT_HEIGHT_NORMAL, FONT_HEIGHT_SMALL, and max().

Referenced by CargoesField::Draw(), DrawCaption(), NetworkContentListWindow::DrawDetails(), SelectCompanyManagerFaceWindow::DrawFaceStringLabel(), DrawFrame(), DrawInset(), DrawPrice(), DrawText(), StatusBarWindow::DrawWidget(), CompanyFinancesWindow::DrawWidget(), ReplaceVehicleWindow::DrawWidget(), NetworkChatWindow::DrawWidget(), GenerateLandscapeWindow::DrawWidget(), MusicWindow::DrawWidget(), NetworkContentListWindow::DrawWidget(), AIConfigWindow::DrawWidget(), NetworkStartServerWindow::DrawWidget(), SelectCompanyManagerFaceWindow::DrawWidget(), GameSettingsWindow::DrawWidget(), NetworkJoinStatusWindow::DrawWidget(), ScenarioEditorToolbarWindow::DrawWidget(), and NetworkGameWindow::OnPaint().

◆ 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
leftThe left most position to draw on.
rightThe right most position to draw on.
topThe top most position to draw on.
strString to draw.
colourColour used for drawing the string, see DoDrawString() for details
alignThe 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.
underlineWhether to underline what has been drawn or not.
fontsizeThe 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 534 of file gfx.cpp.

References DRAW_STRING_BUFFER.

◆ DrawStringMultiLine() [1/2]

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

Draw string, possibly over multiple lines.

Parameters
leftThe left most position to draw on.
rightThe right most position to draw on.
topThe top most position to draw on.
bottomThe bottom most position to draw on.
strString to draw.
colourColour used for drawing the string, see DoDrawString() for details
alignThe horizontal and vertical alignment of the string.
underlineWhether to underline all strings
fontsizeThe 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 620 of file gfx.cpp.

References Layouter::GetBounds().

Referenced by StationViewWindow::DrawAcceptedCargo(), SelectGameWindow::DrawWidget(), BootstrapAskForDownloadWindow::DrawWidget(), NewGRFParametersWindow::DrawWidget(), ErrmsgWindow::DrawWidget(), GameOptionsWindow::DrawWidget(), GoalQuestionWindow::DrawWidget(), TooltipsWindow::DrawWidget(), QueryWindow::DrawWidget(), CompanyWindow::DrawWidget(), BuyCompanyWindow::DrawWidget(), 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
leftThe left most position to draw on.
rightThe right most position to draw on.
topThe top most position to draw on.
bottomThe bottom most position to draw on.
strString to draw.
colourColour used for drawing the string, see DoDrawString() for details
alignThe horizontal and vertical alignment of the string.
underlineWhether to underline all strings
fontsizeThe 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 682 of file gfx.cpp.

References DRAW_STRING_BUFFER.

◆ 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
*nthe DrawPixelInfo that will be the clipping rectangle box allowed for drawing
left,top,width,heightthe 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 1480 of file gfx.cpp.

Referenced by NWidgetMatrix::Draw(), NWidgetLeaf::Draw(), SmallMapWindow::DrawWidget(), and BuildRailStationWindow::DrawWidget().

◆ GameSizeChanged()

void GameSizeChanged ( )

Size of the application screen changed.

Adapt the game screen-size, re-allocate the open windows, and repaint everything

Definition at line 591 of file main_gui.cpp.

References _cur_resolution.

◆ 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]frontBroadest digit, which is not 0. (Use this digit as first digit for numbers with more than one digit.)
[out]nextBroadest digit, including 0. (Use this digit for all digits, except the first one; or for numbers with only one digit.)
sizeFont of the digit

Definition at line 1176 of file gfx.cpp.

Referenced by SetDParamMaxDigits().

◆ GetCharacterHeight()

int GetCharacterHeight ( FontSize  size)

Get height of a character for a given font size.

Parameters
sizeFont size to get height of
Returns
Height of characters in the given font (pixels)

Definition at line 63 of file fontcache.cpp.

References FontCache::Get(), and FontCache::GetHeight().

Referenced by NWidgetResizeBase::SetMinimalTextLines().

◆ GetCharacterWidth()

byte GetCharacterWidth ( FontSize  size,
WChar  key 
)

Return width of character glyph.

Parameters
sizeFont of the character
keyCharacter code glyph
Returns
Width of the character glyph

Definition at line 1148 of file gfx.cpp.

References _stringwidth_table, and GetGlyphWidth().

◆ GetCharAtPosition()

const char* GetCharAtPosition ( const char *  str,
int  x,
FontSize  start_fontsize 
)

Get the character from a string that is drawn at a specific position.

Parameters
strString to test.
xPosition relative to the start of the string.
start_fontsizeFont size to start the text with.
Returns
Pointer to the character at the position or NULL if there is no character at the position.

Definition at line 740 of file gfx.cpp.

◆ GetCharPosInString()

Point GetCharPosInString ( const char *  str,
const char *  ch,
FontSize  start_fontsize 
)

Get the leading corner of a character in a single-line string relative to the start of the string.

Parameters
strString containing the character.
chPointer to the character in the string.
start_fontsizeFont size to start the text with.
Returns
Upper left corner of the glyph associated with the character.

Definition at line 727 of file gfx.cpp.

Referenced by Textbuf::UpdateCaretPosition(), and Textbuf::UpdateMarkedText().

◆ GetContrastColour()

TextColour GetContrastColour ( uint8  background)

Determine a contrasty text colour for a coloured background.

Parameters
backgroundBackground colour.
Returns
TC_BLACK or TC_WHITE depending on what gives a better contrast.

Definition at line 1116 of file gfx.cpp.

References Palette::palette.

◆ GetDigitWidth()

byte GetDigitWidth ( FontSize  size)

Return the maximum width of single digit.

Parameters
sizeFont of the digit
Returns
Width of the digit.

Definition at line 1161 of file gfx.cpp.

Referenced by BuildSignalWindow::UpdateWidgetSize().

◆ GetSpriteSize()

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

◆ GetStringBoundingBox() [1/2]

Dimension GetStringBoundingBox ( const char *  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
strstring to calculate pixel-width
start_fontsizeFontsize to start the text with
Returns
string width and height in pixels

Definition at line 699 of file gfx.cpp.

Referenced by VehicleGroupWindow::ComputeGroupInfoSize(), DrawCaption(), DrawText(), TimetableWindow::DrawWidget(), OrdersWindow::DrawWidget(), BaseVehicleListWindow::GetActionDropdownSize(), BaseGraphWindow::GetYLabelWidth(), SelectCompanyManagerFaceWindow::OnInit(), IndustryCargoesWindow::OnInit(), TextfileWindow::SetupScrollbars(), SelectGameWindow::UpdateWidgetSize(), LandInfoWindow::UpdateWidgetSize(), SetDateWindow::UpdateWidgetSize(), StatusBarWindow::UpdateWidgetSize(), BuildObjectWindow::UpdateWidgetSize(), SubsidyListWindow::UpdateWidgetSize(), BootstrapAskForDownloadWindow::UpdateWidgetSize(), BuildBridgeWindow::UpdateWidgetSize(), GoalListWindow::UpdateWidgetSize(), TimetableWindow::UpdateWidgetSize(), NewGRFParametersWindow::UpdateWidgetSize(), ReplaceVehicleWindow::UpdateWidgetSize(), BuildAirportWindow::UpdateWidgetSize(), CompanyFinancesWindow::UpdateWidgetSize(), NewsWindow::UpdateWidgetSize(), MusicTrackSelectionWindow::UpdateWidgetSize(), BuildIndustryWindow::UpdateWidgetSize(), CompanyStationsWindow::UpdateWidgetSize(), GameOptionsWindow::UpdateWidgetSize(), VehicleGroupWindow::UpdateWidgetSize(), GenerateLandscapeWindow::UpdateWidgetSize(), NetworkChatWindow::UpdateWidgetSize(), SaveLoadWindow::UpdateWidgetSize(), BaseGraphWindow::UpdateWidgetSize(), NetworkGameWindow::UpdateWidgetSize(), MusicWindow::UpdateWidgetSize(), NetworkContentListWindow::UpdateWidgetSize(), StoryBookWindow::UpdateWidgetSize(), DepotWindow::UpdateWidgetSize(), TooltipsWindow::UpdateWidgetSize(), AIConfigWindow::UpdateWidgetSize(), TownDirectoryWindow::UpdateWidgetSize(), OrdersWindow::UpdateWidgetSize(), PaymentRatesGraphWindow::UpdateWidgetSize(), CreateScenarioWindow::UpdateWidgetSize(), MessageHistoryWindow::UpdateWidgetSize(), BuildRailStationWindow::UpdateWidgetSize(), NetworkStartServerWindow::UpdateWidgetSize(), CompanyLeagueWindow::UpdateWidgetSize(), GenerateProgressWindow::UpdateWidgetSize(), IndustryDirectoryWindow::UpdateWidgetSize(), StationViewWindow::UpdateWidgetSize(), BuildVehicleWindow::UpdateWidgetSize(), CompanyInfrastructureWindow::UpdateWidgetSize(), NetworkClientListPopupWindow::UpdateWidgetSize(), GameSettingsWindow::UpdateWidgetSize(), NetworkClientListWindow::UpdateWidgetSize(), SavePresetWindow::UpdateWidgetSize(), ScanProgressWindow::UpdateWidgetSize(), ScenarioEditorToolbarWindow::UpdateWidgetSize(), and Textbuf::UpdateWidth().

◆ GetStringBoundingBox() [2/2]

Dimension GetStringBoundingBox ( StringID  strid)

Get bounding box of a string.

Uses parameters set by #DParam if needed. Has the same restrictions as #GetStringBoundingBox(const char *str).

Parameters
stridString to examine.
Returns
Width and height of the bounding box for the string in pixels.

Definition at line 711 of file gfx.cpp.

References DRAW_STRING_BUFFER.

◆ GetStringHeight() [1/2]

int GetStringHeight ( const char *  str,
int  maxw,
FontSize  fontsize 
)

Calculates height of string (in pixels).

The string is changed to a multiline string if needed.

Parameters
strstring to check
maxwmaximum string width
Returns
height of pixels of string when it is drawn

Definition at line 547 of file gfx.cpp.

Referenced by TextfileWindow::GetContentHeight(), StoryBookWindow::GetHeadHeight(), SettingEntry::GetMaxHelpHeight(), StoryBookWindow::GetPageElementHeight(), SelectGameWindow::UpdateWidgetSize(), LandInfoWindow::UpdateWidgetSize(), BootstrapAskForDownloadWindow::UpdateWidgetSize(), ErrmsgWindow::UpdateWidgetSize(), GameOptionsWindow::UpdateWidgetSize(), GoalQuestionWindow::UpdateWidgetSize(), and TooltipsWindow::UpdateWidgetSize().

◆ 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
strstring to check
maxwmaximum string width
Returns
height of pixels of string when it is drawn

Definition at line 559 of file gfx.cpp.

References DRAW_STRING_BUFFER.

◆ GetStringLineCount()

int GetStringLineCount ( StringID  str,
int  maxw 
)

Calculates number of lines of string.

The string is changed to a multiline string if needed.

Parameters
strstring to check
maxwmaximum string width
Returns
number of lines of string when it is drawn

Definition at line 572 of file gfx.cpp.

References DRAW_STRING_BUFFER.

◆ GetStringMultiLineBoundingBox() [1/2]

Dimension GetStringMultiLineBoundingBox ( StringID  str,
const Dimension suggestion 
)

Calculate string bounding box for multi-line strings.

Parameters
strString to check.
suggestionSuggested bounding box.
Returns
Bounding box for the multi-line string, may be bigger than suggestion.

Definition at line 587 of file gfx.cpp.

Referenced by QueryWindow::UpdateWidgetSize().

◆ GetStringMultiLineBoundingBox() [2/2]

Dimension GetStringMultiLineBoundingBox ( const char *  str,
const Dimension suggestion 
)

Calculate string bounding box for multi-line strings.

Parameters
strString to check.
suggestionSuggested bounding box.
Returns
Bounding box for the multi-line string, may be bigger than suggestion.

Definition at line 599 of file gfx.cpp.

◆ 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_NORMAL, right >= left, bottom >= top
Parameters
leftMinimum X (inclusive)
topMinimum Y (inclusive)
rightMaximum X (inclusive)
bottomMaximum Y (inclusive)
colourA 8 bit palette index (FILLRECT_OPAQUE and FILLRECT_CHECKER) or a recolour spritenumber (FILLRECT_RECOLOUR)
modeFILLRECT_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 112 of file gfx.cpp.

References BlitterFactory::GetCurrentBlitter().

Referenced by NWidgetMatrix::Draw(), NWidgetViewport::Draw(), NWidgetToolbarContainer::Draw(), DrawCaption(), NetworkContentListWindow::DrawDetails(), DrawFrame(), BootstrapBackground::DrawWidget(), MusicTrackSelectionWindow::DrawWidget(), MusicWindow::DrawWidget(), TooltipsWindow::DrawWidget(), NewGRFWindow::DrawWidget(), NetworkClientListPopupWindow::DrawWidget(), BuildRailWaypointWindow::DrawWidget(), SavePresetWindow::DrawWidget(), and NetworkGameWindow::OnPaint().

◆ HandleKeypress()

void HandleKeypress ( uint  keycode,
WChar  key 
)

Handle keyboard input.

Parameters
keycodeVirtual keycode of the key.
keyUnicode character of the key.

Definition at line 2625 of file window.cpp.

Referenced by HandleCharMsg().

◆ HandleTextInput()

void HandleTextInput ( const char *  str,
bool  marked,
const char *  caret,
const char *  insert_location,
const char *  replacement_end 
)

Handle text input.

Parameters
strText string to input.
markedIs the input a marked composition string from an IME?
caretMove the caret to this point in the insertion string.

Definition at line 2713 of file window.cpp.

References EditBoxInGlobalFocus(), NWidgetCore::index, Window::InsertTextString(), Window::nested_focus, WC_CONSOLE, and Window::window_class.

Referenced by CancelIMEComposition(), and HandleIMEComposition().

◆ LoadStringWidthTable()

void LoadStringWidthTable ( bool  monospace)

Initialize _stringwidth_table cache.

Parameters
monospaceWhether to load the monospace cache or the normal fonts.

Definition at line 1130 of file gfx.cpp.

References FS_BEGIN, and FS_MONO.

Referenced by ReloadNewGRFData().

◆ SetAnimatedMouseCursor()

void SetAnimatedMouseCursor ( const AnimCursor table)

Assign an animation to the cursor.

Parameters
tableArray of animation states.
See also
SetMouseCursor

Definition at line 1630 of file gfx.cpp.

References CursorVars::animate_cur, CursorVars::animate_list, PalSpriteID::pal, and CursorVars::sprite_seq.

Referenced by CenterBounds().

◆ SetDirtyBlocks()

void SetDirtyBlocks ( int  left,
int  top,
int  right,
int  bottom 
)

This function extends the internal _invalid_rect rectangle as it now contains the rectangle defined by the given parameters.

Note the point (0,0) is top left.

Parameters
leftThe left edge of the rectangle
topThe top edge of the rectangle
rightThe right edge of the rectangle
bottomThe bottom edge of the rectangle
See also
DrawDirtyBlocks
Todo:
The name of the function should be called like AddDirtyBlock as it neither set a dirty rect nor add several dirty rects although the function name is in plural. (Progman)

Definition at line 1418 of file gfx.cpp.

Referenced by MarkViewportDirty(), MarkWholeScreenDirty(), NWidgetBase::SetDirty(), Window::SetDirty(), and NewsWindow::SetWindowTop().

◆ SetMouseCursor()

void SetMouseCursor ( CursorID  sprite,
PaletteID  pal 
)

Assign a single non-animated sprite to the cursor.

Parameters
spriteSprite to draw for the cursor.
palPalette to use for recolouring.
See also
SetAnimatedMouseCursor

Definition at line 1617 of file gfx.cpp.

References CursorVars::animate_timeout, and SetCursorSprite().

Referenced by CenterBounds(), and SetMouseCursorBusy().

◆ SetMouseCursorBusy()

void SetMouseCursorBusy ( bool  busy)

Set or unset the ZZZ cursor.

Parameters
busyWhether to show the ZZZ cursor.

Definition at line 1602 of file gfx.cpp.

References SetMouseCursor(), SPR_CURSOR_MOUSE, PalSpriteID::sprite, and CursorVars::sprite_seq.

Referenced by CenterBounds(), CleanupGeneration(), and GenerateProgressWindow::OnClick().

◆ UpdateCursorSize()

void UpdateCursorSize ( )

Update cursor dimension.

Called when changing cursor sprite resp. reloading grfs.

Definition at line 1530 of file gfx.cpp.

References GetMaxSpriteID().

Referenced by SetCursorSprite().

Variable Documentation

◆ _palette_remap_grf

bool _palette_remap_grf[]

Whether the given NewGRFs must get a palette remap from windows to DOS or not.

Definition at line 32 of file gfxinit.cpp.

Referenced by LoadSpriteTables().

◆ DRAW_STRING_BUFFER

const int DRAW_STRING_BUFFER = 2048
static