OpenTTD
Functions | Variables
Dirty

Handles the repaint of some part of the screen. More...

Functions

void MarkWholeScreenDirty ()
 This function mark the whole screen as dirty. More...
 
static void TerraformAddDirtyTile (TerraformerState *ts, TileIndex tile)
 Adds a tile to the "tile_table" in a TerraformerState. More...
 
static void TerraformAddDirtyTileAround (TerraformerState *ts, TileIndex tile)
 Adds all tiles that incident with the north corner of a specific tile to the "tile_table" in a TerraformerState. More...
 
virtual void Vehicle::MarkDirty ()
 Marks the vehicles to be redrawn and updates cached variables. More...
 
static void MarkViewportDirty (const ViewPort *vp, int left, int top, int right, int bottom)
 Marks a viewport as dirty for repaint if it displays (a part of) the area the needs to be repainted. More...
 
void MarkAllViewportsDirty (int left, int top, int right, int bottom)
 Mark all viewports that display an area as dirty (in need of repaint). More...
 
void MarkTileDirtyByTile (TileIndex tile, int bridge_level_offset)
 Mark a tile given by its index dirty for repaint. More...
 
void MarkTileDirtyByTileOutsideMap (int x, int y)
 Mark a (virtual) tile outside the map dirty for repaint. More...
 
static void SetSelectionTilesDirty ()
 Marks the selected tiles as dirty. More...
 
static void MarkCanalsAndRiversAroundDirty (TileIndex tile)
 Marks the tiles around a tile as dirty, if they are canals or rivers. More...
 
void Station::MarkTilesDirty (bool cargo_change) const
 Marks the tiles of the station as dirty.
 
void ViewportSign::MarkDirty (ZoomLevel maxzoom=ZOOM_LVL_MAX) const
 Mark the sign dirty in all viewports. More...
 
void Window::SetDirty () const
 Mark entire window as dirty (in need of re-paint)
 

Variables

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

Detailed Description

Handles the repaint of some part of the screen.

Some places in the code are called functions which makes something "dirty". This has nothing to do with making a Tile or Window darker or less visible. This term comes from memory caching and is used to define an object must be repaint. If some data of an object (like a Tile, Window, Vehicle, whatever) are changed which are so extensive the object must be repaint its marked as "dirty". The video driver repaint this object instead of the whole screen (this is btw. also possible if needed). This is used to avoid a flickering of the screen by the video driver constantly repainting it.

This whole mechanism is controlled by an rectangle defined in _invalid_rect. This rectangle defines the area on the screen which must be repaint. If a new object needs to be repainted this rectangle is extended to 'catch' the object on the screen. At some point (which is normally uninteresting for patch writers) this rectangle is send to the video drivers method VideoDriver::MakeDirty and it is truncated back to an empty rectangle. At some later point (which is uninteresting, too) the video driver repaints all these saved rectangle instead of the whole screen and drop the rectangle informations. Then a new round begins by marking objects "dirty".

See also
VideoDriver::MakeDirty
_invalid_rect
_screen

Function Documentation

◆ MarkAllViewportsDirty()

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

Mark all viewports that display an area as dirty (in need of repaint).

Parameters
leftLeft edge of area to repaint. (viewport coordinates, that is wrt. ZOOM_LVL_NORMAL)
topTop edge of area to repaint. (viewport coordinates, that is wrt. ZOOM_LVL_NORMAL)
rightRight edge of area to repaint. (viewport coordinates, that is wrt. ZOOM_LVL_NORMAL)
bottomBottom edge of area to repaint. (viewport coordinates, that is wrt. ZOOM_LVL_NORMAL)

Definition at line 1872 of file viewport.cpp.

Referenced by Vehicle::FindClosestDepot(), Vehicle::MarkAllViewportsDirty(), MarkTileDirtyByTile(), MarkTileDirtyByTileOutsideMap(), and Vehicle::~Vehicle().

◆ MarkCanalsAndRiversAroundDirty()

static void MarkCanalsAndRiversAroundDirty ( TileIndex  tile)
static

Marks the tiles around a tile as dirty, if they are canals or rivers.

Parameters
tileThe center of the tile where all other tiles are marked as dirty

Definition at line 85 of file water_cmd.cpp.

References DIR_BEGIN, DIR_END, MarkTileDirtyIfCanalOrRiver(), and TileOffsByDir().

◆ MarkDirty() [1/2]

void ViewportSign::MarkDirty ( ZoomLevel  maxzoom = ZOOM_LVL_MAX) const

Mark the sign dirty in all viewports.

Parameters
maxzoomMaximum ZoomLevel at which the text is visible.

Definition at line 1341 of file viewport.cpp.

References FONT_HEIGHT_NORMAL, ScaleByZoom(), VPSM_BOTTOM, VPSM_TOP, ZOOM_LVL_BEGIN, ZOOM_LVL_COUNT, and ZOOM_LVL_END.

Referenced by TextEffect::Reset().

◆ MarkDirty() [2/2]

virtual void Vehicle::MarkDirty ( )
inlinevirtual

Marks the vehicles to be redrawn and updates cached variables.

This method marks the area of the vehicle on the screen as dirty. It can be use to repaint the vehicle.

Reimplemented in Train, RoadVehicle, Aircraft, and Ship.

Definition at line 364 of file vehicle_base.h.

Referenced by CmdStartStopVehicle(), and Train::~Train().

◆ MarkTileDirtyByTile()

void MarkTileDirtyByTile ( TileIndex  tile,
int  bridge_level_offset 
)

◆ MarkTileDirtyByTileOutsideMap()

void MarkTileDirtyByTileOutsideMap ( int  x,
int  y 
)

Mark a (virtual) tile outside the map dirty for repaint.

Parameters
xTile X position.
yTile Y position.

Definition at line 1920 of file viewport.cpp.

References MarkAllViewportsDirty(), MAX_TILE_EXTENT_BOTTOM, MAX_TILE_EXTENT_LEFT, MAX_TILE_EXTENT_RIGHT, RemapCoords(), TILE_SIZE, and TilePixelHeightOutsideMap().

◆ MarkViewportDirty()

static void MarkViewportDirty ( const ViewPort vp,
int  left,
int  top,
int  right,
int  bottom 
)
static

Marks a viewport as dirty for repaint if it displays (a part of) the area the needs to be repainted.

Parameters
vpThe viewport to mark as dirty
leftLeft edge of area to repaint
topTop edge of area to repaint
rightRight edge of area to repaint
bottomBottom edge of area to repaint

Definition at line 1836 of file viewport.cpp.

References ViewPort::left, max(), SetDirtyBlocks(), ViewPort::top, UnScaleByZoom(), UnScaleByZoomLower(), ViewPort::virtual_height, ViewPort::virtual_left, ViewPort::virtual_top, ViewPort::virtual_width, and ViewPort::zoom.

◆ MarkWholeScreenDirty()

void MarkWholeScreenDirty ( )

This function mark the whole screen as dirty.

This results in repainting the whole screen. Use this with care as this function will break the idea about marking only parts of the screen as 'dirty'.

Definition at line 1461 of file gfx.cpp.

References SetDirtyBlocks().

Referenced by CmdRenameCompany(), CmdRenameEngine(), CmdRenamePresident(), CmdRenameVehicle(), CmdSetCompanyManagerFace(), DoScanNewGRFFiles(), FlatEmptyWorld(), and ScanNewGRFFiles().

◆ SetSelectionTilesDirty()

static void SetSelectionTilesDirty ( )
static

Marks the selected tiles as dirty.

This function marks the selected tiles as dirty for repaint

Definition at line 1937 of file viewport.cpp.

References TileHighlightData::diagonal, TileHighlightData::offs, TileHighlightData::outersize, TileHighlightData::pos, TileHighlightData::size, and TILE_SIZE.

Referenced by SetObjectToPlace().

◆ TerraformAddDirtyTile()

static void TerraformAddDirtyTile ( TerraformerState ts,
TileIndex  tile 
)
static

Adds a tile to the "tile_table" in a TerraformerState.

Parameters
tsTerraformerState.
tileTile.

Definition at line 74 of file terraform_cmd.cpp.

References TerraformerState::dirty_tiles.

Referenced by TerraformAddDirtyTileAround().

◆ TerraformAddDirtyTileAround()

static void TerraformAddDirtyTileAround ( TerraformerState ts,
TileIndex  tile 
)
static

Adds all tiles that incident with the north corner of a specific tile to the "tile_table" in a TerraformerState.

Parameters
tsTerraformerState.
tileTile.

Definition at line 86 of file terraform_cmd.cpp.

References TerraformAddDirtyTile(), TileDiffXY(), TileX(), and TileY().

Variable Documentation

◆ _invalid_rect

Rect _invalid_rect
static

The rect for repaint.

This rectangle defines the area which should be repaint by the video driver.

Definition at line 69 of file gfx.cpp.