Revert: "Cleanup: Give SetDirtyBlocks a more descriptive name."

This reverts commit 8652a4db76.
This is necessary to aid in the cherry-picking of commits from JGRPP.
This commit is contained in:
TechGeekNZ
2020-06-12 09:34:34 +12:00
parent b84d61ef6e
commit c9abf6ade6
6 changed files with 15 additions and 24 deletions

View File

@@ -1416,16 +1416,6 @@ void DrawMouseCursor()
_cursor.dirty = false;
}
/**
* Repaints a specific rectangle of the screen.
*
* @param left,top,right,bottom The area of the screen that needs repainting
* @pre The rectangle should have been previously marked dirty with \c AddDirtyBlock.
* @see AddDirtyBlock
* @see DrawDirtyBlocks
* @ingroup dirty
*
*/
void RedrawScreenRect(int left, int top, int right, int bottom)
{
assert(right <= _screen.width && bottom <= _screen.height);
@@ -1448,9 +1438,7 @@ void RedrawScreenRect(int left, int top, int right, int bottom)
/**
* Repaints the rectangle blocks which are marked as 'dirty'.
*
* @see AddDirtyBlock
*
* @ingroup dirty
* @see SetDirtyBlocks
*/
void DrawDirtyBlocks()
{
@@ -1553,18 +1541,21 @@ void DrawDirtyBlocks()
}
/**
* Extend the internal _invalid_rect rectangle to contain the rectangle
* defined by the given parameters. Note the point (0,0) is top left.
* 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.
*
* @param left The left edge of the rectangle
* @param top The top edge of the rectangle
* @param right The right edge of the rectangle
* @param bottom The bottom edge of the rectangle
* @see DrawDirtyBlocks
* @ingroup dirty
*
* @todo The name of the function should be called like @c AddDirtyBlock as
* it neither set a dirty rect nor add several dirty rects although
* the function name is in plural. (Progman)
*/
void AddDirtyBlock(int left, int top, int right, int bottom)
void SetDirtyBlocks(int left, int top, int right, int bottom)
{
byte *b;
int width;
@@ -1609,7 +1600,7 @@ void AddDirtyBlock(int left, int top, int right, int bottom)
*/
void MarkWholeScreenDirty()
{
AddDirtyBlock(0, 0, _screen.width, _screen.height);
SetDirtyBlocks(0, 0, _screen.width, _screen.height);
}
/**