(svn r11065) -Documentation [FS#1186]: of the dirty marking/repainting subsystem. Patch by Progman.

This commit is contained in:
rubidium
2007-09-09 10:13:17 +00:00
parent ef4d248325
commit 65f9a0f21a
14 changed files with 187 additions and 10 deletions

View File

@@ -103,7 +103,18 @@ StringID RealAllocateName(const char *name, byte skip, bool check_double);
void ConvertNameArray();
/* misc functions */
/**
* Mark a tile given by its coordinate dirty for repaint.
*
* @ingroup dirty
*/
void MarkTileDirty(int x, int y);
/**
* Mark a tile given by its index dirty for repaint.
*
* @ingroup dirty
*/
void MarkTileDirtyByTile(TileIndex tile);
void InvalidateWindow(WindowClass cls, WindowNumber number);
void InvalidateWindowWidget(WindowClass cls, WindowNumber number, byte widget_index);
@@ -124,6 +135,12 @@ bool ScrollMainWindowTo(int x, int y, bool instant = false);
void DrawSprite(SpriteID img, SpriteID pal, int x, int y);
bool EnsureNoVehicle(TileIndex tile);
bool EnsureNoVehicleOnGround(TileIndex tile);
/**
* Mark all viewports dirty for repaint.
*
* @ingroup dirty
*/
void MarkAllViewportsDirty(int left, int top, int right, int bottom);
void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost);
void ShowFeederIncomeAnimation(int x, int y, int z, Money cost);