Merge branch 'master' of github.com:diasurgical/devilution

Source/control.cpp

@@ -186,8 +186,8 @@ int SpellPages[6][7] = {
 
 /**
  * Draw spell cell onto the back buffer.
- * @param xp Backbuffer coordinate
+ * @param xp Back buffer coordinate
- * @param yp Backbuffer coordinate
+ * @param yp Back buffer coordinate
  * @param Trans Pointer to the cel buffer.
  * @param nCel Index of the cel frame to draw. 0 based.
  * @param w Width of the frame.
@@ -465,7 +465,7 @@ void ToggleSpell(int slot)
 }
 
 /**
- * @brief Print letter to the backbuffer
+ * @brief Print letter to the back buffer
  * @param sx Backbuffer offset
  * @param sy Backbuffer offset
  * @param nCel Number of letter in Windows-1252
@@ -559,8 +559,8 @@ void DrawPanelBox(int x, int y, int w, int h, int sx, int sy)
  * @param pCelBuff Buffer of the empty flask cel.
  * @param min Top of the flask cel section to draw.
  * @param max Bottom of the flask cel section to draw.
- * @param sx X Backbuffer coordinate
+ * @param sx Back buffer coordinate
- * @param sy Y Backbuffer coordinate
+ * @param sy Back buffer coordinate
  */
 void SetFlaskHeight(BYTE *pCelBuff, int min, int max, int sx, int sy)
 {

Source/engine.cpp

@@ -12,14 +12,36 @@ static CCritSect sgMemCrit;
 int SeedCount;
 BOOL gbNotInView; // valid - if x/y are in bounds
 
+/**
+ * Specifies the increment used in the Borland C/C++ pseudo-random.
+ */
 const int RndInc = 1;
+
+/**
+ * Specifies the multiplier used in the Borland C/C++ pseudo-random number generator algorithm.
+ */
 const int RndMult = 0x015A4E35;
 
+/**
+ * @brief Blit CEL sprite to the back buffer at the given coordinates
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelDraw(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	CelBlitFrame(&gpBuffer[sx + BUFFER_WIDTH * sy], pCelBuff, nCel, nWidth);
 }
 
+/**
+ * @brief Blit a given CEL frame to the given buffer
+ * @param pBuff Target buffer
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelBlitFrame(BYTE *pBuff, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	int nDataSize;
@@ -32,6 +54,14 @@ void CelBlitFrame(BYTE *pBuff, BYTE *pCelBuff, int nCel, int nWidth)
 	CelBlitSafe(pBuff, pRLEBytes, nDataSize, nWidth);
 }
 
+/**
+ * @brief Same as CelDraw but with the option to skip parts of the top and bottom of the sprite
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelClippedDraw(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	BYTE *pRLEBytes;
@@ -49,6 +79,14 @@ void CelClippedDraw(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 	    nWidth);
 }
 
+/**
+ * @brief Blit CEL sprite, and apply lighting, to the back buffer at the given coordinates
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelDrawLight(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, BYTE *tbl)
 {
 	int nDataSize;
@@ -66,6 +104,14 @@ void CelDrawLight(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, BYTE *tb
 		CelBlitSafe(pDecodeTo, pRLEBytes, nDataSize, nWidth);
 }
 
+/**
+ * @brief Same as CelDrawLight but with the option to skip parts of the top and bottom of the sprite
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelClippedDrawLight(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	int nDataSize;
@@ -83,6 +129,15 @@ void CelClippedDrawLight(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 		CelBlitSafe(pDecodeTo, pRLEBytes, nDataSize, nWidth);
 }
 
+/**
+ * @brief Blit CEL sprite, and apply lighting, to the back buffer at the given coordinates, translated to a red hue
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ * @param light Light shade to use
+ */
 void CelDrawLightRed(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, char light)
 {
 	int nDataSize, w, idx;
@@ -127,7 +182,11 @@ void CelDrawLightRed(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, char
 }
 
 /**
- * @brief Same as CelBlit but checks for drawing outside the buffer
+ * @brief Blit CEL sprite to the given buffer, checks for drawing outside the buffer
+ * @param pDecodeTo The output buffer
+ * @param pRLEBytes CEL pixel stream (run-length encoded)
+ * @param nDataSize Size of CEL in bytes
+ * @param nWidth Width of sprite
  */
 void CelBlitSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth)
 {
@@ -162,6 +221,14 @@ void CelBlitSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth)
 	}
 }
 
+/**
+ * @brief Same as CelClippedDraw but checks for drawing outside the buffer
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelClippedDrawSafe(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	BYTE *pRLEBytes;
@@ -180,7 +247,12 @@ void CelClippedDrawSafe(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 }
 
 /**
- * @brief Same as CelBlitLight but checks for drawing outside the buffer
+ * @brief Blit CEL sprite, and apply lighting, to the given buffer, checks for drawing outside the buffer
+ * @param pDecodeTo The output buffer
+ * @param pRLEBytes CEL pixel stream (run-length encoded)
+ * @param nDataSize Size of CEL in bytes
+ * @param nWidth Width of sprite
+ * @param tbl Palette translation table
  */
 void CelBlitLightSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth, BYTE *tbl)
 {
@@ -239,7 +311,11 @@ void CelBlitLightSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidt
 }
 
 /**
- * @brief Same as CelBlitLightTrans but checks for drawing outside the buffer
+ * @brief Same as CelBlitLightSafe, with transparancy applied
+ * @param pDecodeTo The output buffer
+ * @param pRLEBytes CEL pixel stream (run-length encoded)
+ * @param nDataSize Size of CEL in bytes
+ * @param nWidth Width of sprite
  */
 void CelBlitLightTransSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth)
 {
@@ -324,6 +400,13 @@ void CelBlitLightTransSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int
 	}
 }
 
+/**
+ * @brief Same as CelBlitLightTransSafe
+ * @param pBuff Target buffer
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelClippedBlitLightTrans(BYTE *pBuff, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	int nDataSize;
@@ -341,6 +424,15 @@ void CelClippedBlitLightTrans(BYTE *pBuff, BYTE *pCelBuff, int nCel, int nWidth)
 		CelBlitSafe(pBuff, pRLEBytes, nDataSize, nWidth);
 }
 
+/**
+ * @brief Same as CelDrawLightRed but checks for drawing outside the buffer
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff Cel data
+ * @param nCel CEL frame number
+ * @param nWidth Width of cel
+ * @param light Light shade to use
+ */
 void CelDrawLightRedSafe(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, char light)
 {
 	int nDataSize, w, idx;
@@ -397,7 +489,7 @@ void CelDrawLightRedSafe(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, c
  * @param y Cordinate in pBuff buffer
  * @param wdt Width of pBuff
  * @param pCelBuff Cel data
- * @param nCel Frame of cel
+ * @param nCel CEL frame number
  * @param nWidth Width of cel
  */
 void CelBlitWidth(BYTE *pBuff, int x, int y, int wdt, BYTE *pCelBuff, int nCel, int nWidth)
@@ -431,6 +523,15 @@ void CelBlitWidth(BYTE *pBuff, int x, int y, int wdt, BYTE *pCelBuff, int nCel,
 	}
 }
 
+/**
+ * @brief Blit a solid colder shape one pixel larger then the given sprite shape, to the back buffer at the given coordianates
+ * @param col Color index from current palette
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff CEL buffer
+ * @param nCel CEL frame number
+ * @param nWidth Width of sprite
+ */
 void CelBlitOutline(char col, int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	int nDataSize, w;
@@ -485,6 +586,12 @@ void CelBlitOutline(char col, int sx, int sy, BYTE *pCelBuff, int nCel, int nWid
 	}
 }
 
+/**
+ * @brief Set the value of a single pixel in the back buffer, checks bounds
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param col Color index from current palette
+ */
 void ENG_set_pixel(int sx, int sy, BYTE col)
 {
 	BYTE *dst;
@@ -500,6 +607,11 @@ void ENG_set_pixel(int sx, int sy, BYTE col)
 		*dst = col;
 }
 
+/**
+ * @brief Set the value of a single pixel in the back buffer to that of gbPixelCol, checks bounds
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ */
 void engine_draw_pixel(int sx, int sy)
 {
 	BYTE *dst;
@@ -520,18 +632,6 @@ void engine_draw_pixel(int sx, int sy)
 		*dst = gbPixelCol;
 }
 
-// Exact copy from https://github.com/erich666/GraphicsGems/blob/dad26f941e12c8bf1f96ea21c1c04cd2206ae7c9/gems/DoubleLine.c
-// Except:
-// * not in view checks
-// * global variable instead of reverse flag
-// * condition for pixels_left < 0 removed
-
-/*
-Symmetric Double Step Line Algorithm
-by Brian Wyvill
-from "Graphics Gems", Academic Press, 1990
-*/
-
 #define GG_SWAP(A, B) \
 	{                 \
 		(A) ^= (B);   \
@@ -540,6 +640,24 @@ from "Graphics Gems", Academic Press, 1990
 	}
 #define GG_ABSOLUTE(I, J, K) (((I) - (J)) * ((K) = (((I) - (J)) < 0 ? -1 : 1)))
 
+/**
+ * Symmetric Double Step Line Algorithm
+ * by Brian Wyvill
+ * from "Graphics Gems", Academic Press, 1990
+ *
+ * Exact copy from https://github.com/erich666/GraphicsGems/blob/dad26f941e12c8bf1f96ea21c1c04cd2206ae7c9/gems/DoubleLine.c
+ * Except:
+ * - not in view checks
+ * - global variable instead of reverse flag
+ * - condition for pixels_left < 0 removed
+ *
+ * @brief Draw a line on the back buffer
+ * @param x0 Back buffer coordinate
+ * @param y0 Back buffer coordinate
+ * @param x1 Back buffer coordinate
+ * @param y1 Back buffer coordinate
+ * @param col Color index from current palette
+ */
 void DrawLine(int x0, int y0, int x1, int y1, BYTE col)
 {
 	int dx, dy, incr1, incr2, D, x, y, xend, c, pixels_left;
@@ -729,6 +847,14 @@ void DrawLine(int x0, int y0, int x1, int y1, BYTE col)
 	}
 }
 
+/**
+ * @brief Calculate the best fit direction between two points
+ * @param x1 Tile coordinate
+ * @param y1 Tile coordinate
+ * @param x2 Tile coordinate
+ * @param y2 Tile coordinate
+ * @return A value from the direction enum
+ */
 int GetDirection(int x1, int y1, int x2, int y2)
 {
 	int mx, my;
@@ -770,6 +896,10 @@ int GetDirection(int x1, int y1, int x2, int y2)
 	return md;
 }
 
+/**
+ * @brief Set the RNG seed
+ * @param s RNG seed
+ */
 void SetRndSeed(int s)
 {
 	SeedCount = 0;
@@ -777,6 +907,10 @@ void SetRndSeed(int s)
 	orgseed = s;
 }
 
+/**
+ * @brief Get the current RNG seed
+ * @return RNG seed
+ */
 int GetRndSeed()
 {
 	SeedCount++;
@@ -784,6 +918,12 @@ int GetRndSeed()
 	return abs(sglGameSeed);
 }
 
+/**
+ * @brief Main RNG function
+ * @param idx Unused
+ * @param v The upper limit for the return value
+ * @return A random number from 0 to (v-1)
+ */
 int random_(BYTE idx, int v)
 {
 	if (v <= 0)
@@ -793,6 +933,10 @@ int random_(BYTE idx, int v)
 	return GetRndSeed() % v;
 }
 
+/**
+ * @brief Multithreaded safe malloc
+ * @param dwBytes Byte size to allocate
+ */
 BYTE *DiabloAllocPtr(DWORD dwBytes)
 {
 	BYTE *buf;
@@ -810,6 +954,10 @@ BYTE *DiabloAllocPtr(DWORD dwBytes)
 	return buf;
 }
 
+/**
+ * @brief Multithreaded safe memfree
+ * @param p Memory pointer to free
+ */
 void mem_free_dbg(void *p)
 {
 	if (p) {
@@ -819,6 +967,12 @@ void mem_free_dbg(void *p)
 	}
 }
 
+/**
+ * @brief Load a file in to a buffer
+ * @param pszName Path of file
+ * @param pdwFileLen Will be set to file size if non-NULL
+ * @return Buffer with content of file
+ */
 BYTE *LoadFileInMem(char *pszName, DWORD *pdwFileLen)
 {
 	HANDLE file;
@@ -842,6 +996,12 @@ BYTE *LoadFileInMem(char *pszName, DWORD *pdwFileLen)
 	return buf;
 }
 
+/**
+ * @brief Load a file in to the given buffer
+ * @param pszName Path of file
+ * @param p Target buffer
+ * @return Size of file
+ */
 DWORD LoadFileWithMem(const char *pszName, void *p)
 {
 	DWORD dwFileLen;
@@ -867,6 +1027,9 @@ DWORD LoadFileWithMem(const char *pszName, void *p)
 
 /**
  * @brief Apply the color swaps to a CL2 sprite
+ * @param p CL2 buffer
+ * @param ttbl Palette translation table
+ * @param nCel Frame number in CL2 file
  */
 void Cl2ApplyTrans(BYTE *p, BYTE *ttbl, int nCel)
 {
@@ -905,6 +1068,14 @@ void Cl2ApplyTrans(BYTE *p, BYTE *ttbl, int nCel)
 	}
 }
 
+/**
+ * @brief Blit CL2 sprite, to the back buffer at the given coordianates
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff CL2 buffer
+ * @param nCel CL2 frame number
+ * @param nWidth Width of sprite
+ */
 void Cl2Draw(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	BYTE *pRLEBytes;
@@ -923,6 +1094,13 @@ void Cl2Draw(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 	    nWidth);
 }
 
+/**
+ * @brief Blit CL2 sprite to the given buffer
+ * @param pDecodeTo The output buffer
+ * @param pRLEBytes CL2 pixel stream (run-length encoded)
+ * @param nDataSize Size of CL2 in bytes
+ * @param nWidth Width of sprite
+ */
 void Cl2BlitSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth)
 {
 	int w;
@@ -994,6 +1172,15 @@ void Cl2BlitSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth)
 	}
 }
 
+/**
+ * @brief Blit a solid colder shape one pixel larger then the given sprite shape, to the back buffer at the given coordianates
+ * @param col Color index from current palette
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff CL2 buffer
+ * @param nCel CL2 frame number
+ * @param nWidth Width of sprite
+ */
 void Cl2DrawOutline(char col, int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	int nDataSize;
@@ -1015,6 +1202,14 @@ void Cl2DrawOutline(char col, int sx, int sy, BYTE *pCelBuff, int nCel, int nWid
 	gpBufEnd += BUFFER_WIDTH;
 }
 
+/**
+ * @brief Blit a solid colder shape one pixel larger then the given sprite shape, to the given buffer
+ * @param pDecodeTo The output buffer
+ * @param pRLEBytes CL2 pixel stream (run-length encoded)
+ * @param nDataSize Size of CL2 in bytes
+ * @param nWidth Width of sprite
+ * @param col Color index from current palette
+ */
 void Cl2BlitOutlineSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth, char col)
 {
 	int w;
@@ -1091,6 +1286,15 @@ void Cl2BlitOutlineSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWi
 	}
 }
 
+/**
+ * @brief Blit CL2 sprite, and apply a given lighting, to the back buffer at the given coordianates
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff CL2 buffer
+ * @param nCel CL2 frame number
+ * @param nWidth Width of sprite
+ * @param light Light shade to use
+ */
 void Cl2DrawLightTbl(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, char light)
 {
 	int nDataSize, idx;
@@ -1117,6 +1321,14 @@ void Cl2DrawLightTbl(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth, char
 	    &pLightTbl[idx]);
 }
 
+/**
+ * @brief Blit CL2 sprite, and apply lighting, to the given buffer
+ * @param pDecodeTo The output buffer
+ * @param pRLEBytes CL2 pixel stream (run-length encoded)
+ * @param nDataSize Size of CL2 in bytes
+ * @param nWidth With of CL2 sprite
+ * @param pTable Light color table
+ */
 void Cl2BlitLightSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidth, BYTE *pTable)
 {
 	int w;
@@ -1189,6 +1401,14 @@ void Cl2BlitLightSafe(BYTE *pDecodeTo, BYTE *pRLEBytes, int nDataSize, int nWidt
 	}
 }
 
+/**
+ * @brief Blit CL2 sprite, and apply lighting, to the back buffer at the given coordinates
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pCelBuff CL2 buffer
+ * @param nCel CL2 frame number
+ * @param nWidth Width of sprite
+ */
 void Cl2DrawLight(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 {
 	int nDataSize;
@@ -1207,6 +1427,10 @@ void Cl2DrawLight(int sx, int sy, BYTE *pCelBuff, int nCel, int nWidth)
 		Cl2BlitSafe(pDecodeTo, pRLEBytes, nDataSize, nWidth);
 }
 
+/**
+ * @brief Fade to black and play a video
+ * @param pszMovie file path of movie
+ */
 void PlayInGameMovie(char *pszMovie)
 {
 	PaletteFadeOut(8);

Source/lighting.cpp

@@ -16,28 +16,29 @@ int visionid;
 BYTE *pLightTbl;
 BOOL lightflag;
 
-// CrawlTable specifies X- and Y-coordinate deltas from a missile target
+/**
-// coordinate.
+ * CrawlTable specifies X- and Y-coordinate deltas from a missile target coordinate.
-//
+ *
-// n=4
+ * n=4
-//
+ *
-//    y
+ *    y
-//    ^
+ *    ^
-//    |  1
+ *    |  1
-//    | 3#4
+ *    | 3#4
-//    |  2
+ *    |  2
-//    +-----> x
+ *    +-----> x
-//
+ *
-// n=16
+ * n=16
-//
+ *
-//    y
+ *    y
-//    ^
+ *    ^
-//    |  314
+ *    |  314
-//    | B7 8C
+ *    | B7 8C
-//    | F # G
+ *    | F # G
-//    | D9 AE
+ *    | D9 AE
-//    |  526
+ *    |  526
-//    +-------> x
+ *    +-------> x
+ */
 char CrawlTable[2749] = {
 	1,
 	0, 0,
@@ -402,8 +403,9 @@ char CrawlTable[2749] = {
 	-18, -1, 18, -1, -18, 0, 18, 0
 };
 
-// pCrawlTable maps from circle radius to the X- and Y-coordinate deltas from
+/**
-// the center of a circle.
+ * pCrawlTable maps from circle radius to the X- and Y-coordinate deltas from the center of a circle.
+ */
 char *pCrawlTable[19] = {
 	CrawlTable,
 	CrawlTable + 3,
@@ -425,6 +427,9 @@ char *pCrawlTable[19] = {
 	CrawlTable + 2187,
 	CrawlTable + 2460
 };
+/**
+ * vCrawlTable specifies the X- Y-coordinate offsets of lighting visions.
+ */
 BYTE vCrawlTable[23][30] = {
 	{ 1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0, 7, 0, 8, 0, 9, 0, 10, 0, 11, 0, 12, 0, 13, 0, 14, 0, 15, 0 },
 	{ 1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0, 7, 0, 8, 1, 9, 1, 10, 1, 11, 1, 12, 1, 13, 1, 14, 1, 15, 1 },
@@ -472,6 +477,9 @@ BYTE byte_49463C[18][18] = /* unused */
 	    { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2 }
     };
 
+/**
+ * RadiusAdj maps from vCrawlTable index to lighting vision radius adjustment.
+ */
 BYTE RadiusAdj[23] = { 0, 0, 0, 0, 1, 1, 1, 2, 2, 2, 3, 4, 3, 2, 2, 2, 1, 1, 1, 0, 0, 0, 0 };
 
 void RotateRadius(int *x, int *y, int *dx, int *dy, int *lx, int *ly, int *bx, int *by)

Source/scrollrt.cpp

@@ -2,18 +2,43 @@
 
 DEVILUTION_BEGIN_NAMESPACE
 
+/**
+ * Specifies the current light entry.
+ */
 int light_table_index;
 DWORD sgdwCursWdtOld;
 DWORD sgdwCursX;
 DWORD sgdwCursY;
+/**
+ * Upper bound of back buffer.
+ */
 BYTE *gpBufStart;
+/**
+ * Lower bound of back buffer.
+ */
 BYTE *gpBufEnd;
 DWORD sgdwCursHgt;
+
+/**
+ * Specifies the current MIN block of the level CEL file, as used during rendering of the level tiles.
+ *
+ * frameNum  := block & 0x0FFF
+ * frameType := block & 0x7000 >> 12
+ */
 DWORD level_cel_block;
 DWORD sgdwCursXOld;
 DWORD sgdwCursYOld;
+/**
+ * Specifies the type of arches to render.
+ */
 char arch_draw_type;
+/**
+ * Specifies whether transparency is active for the current CEL file being decoded.
+ */
 int cel_transparency_active;
+/**
+ * Specifies the current dungeon piece ID of the level, as used during rendering of the level tiles.
+ */
 int level_piece_id;
 DWORD sgdwCursWdt;
 void (*DrawPlrProc)(int, int, int, int, int, BYTE *, int, int, int, int);
@@ -59,6 +84,9 @@ char *szPlrModeAssert[12] = {
 	"quitting"
 };
 
+/**
+ * @brief Clear cursor state
+ */
 void ClearCursor() // CODE_FIX: this was supposed to be in cursor.cpp
 {
 	sgdwCursWdt = 0;
@@ -66,7 +94,7 @@ void ClearCursor() // CODE_FIX: this was supposed to be in cursor.cpp
 }
 
 /**
- * @brief Remove the cursor from the backbuffer
+ * @brief Remove the cursor from the back buffer
  */
 static void scrollrt_draw_cursor_back_buffer()
 {
@@ -98,7 +126,7 @@ static void scrollrt_draw_cursor_back_buffer()
 }
 
 /**
- * @brief Draw the cursor on the backbuffer
+ * @brief Draw the cursor on the back buffer
  */
 static void scrollrt_draw_cursor_item()
 {
@@ -178,6 +206,13 @@ static void scrollrt_draw_cursor_item()
 	}
 }
 
+/**
+ * @brief Render a missile sprite
+ * @param m Pointer to MissileStruct struct
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pre Is the sprite in the background
+ */
 void DrawMissilePrivate(MissileStruct *m, int sx, int sy, BOOL pre)
 {
 	int mx, my, nCel, frames;
@@ -208,11 +243,11 @@ void DrawMissilePrivate(MissileStruct *m, int sx, int sy, BOOL pre)
 }
 
 /**
- * @brief Render a missile sprite
+ * @brief Render a missile sprites for a given tile
  * @param x dPiece coordinate
  * @param y dPiece coordinate
- * @param sx Backbuffer coordinate
+ * @param sx Back buffer coordinate
- * @param sy Backbuffer coordinate
+ * @param sy Back buffer coordinate
  * @param pre Is the sprite in the background
  */
 void DrawMissile(int x, int y, int sx, int sy, BOOL pre)
@@ -242,8 +277,9 @@ void DrawMissile(int x, int y, int sx, int sy, BOOL pre)
  * @brief Render a monster sprite
  * @param x dPiece coordinate
  * @param y dPiece coordinate
- * @param mx Backbuffer coordinate
+ * @param mx Back buffer coordinate
- * @param my Backbuffer coordinate
+ * @param my Back buffer coordinate
+ * @param m Id of monster
  */
 static void DrawMonster(int x, int y, int mx, int my, int m)
 {
@@ -298,12 +334,12 @@ static void DrawMonster(int x, int y, int mx, int my, int m)
 }
 
 /**
- * @brief Render a monster sprite
+ * @brief Render a player sprite
  * @param pnum Player id
  * @param x dPiece coordinate
  * @param y dPiece coordinate
- * @param px Backbuffer coordinate
+ * @param px Back buffer coordinate
- * @param py Backbuffer coordinate
+ * @param py Back buffer coordinate
  * @param pCelBuff sprite buffer
  * @param nCel frame
  * @param nWidth width
@@ -375,11 +411,11 @@ static void DrawPlayer(int pnum, int x, int y, int px, int py, BYTE *pCelBuff, i
 }
 
 /**
- * @brief Render a monster sprite
+ * @brief Render a player sprite
  * @param x dPiece coordinate
  * @param y dPiece coordinate
- * @param sx Backbuffer coordinate
+ * @param sx Back buffer coordinate
- * @param sy Backbuffer coordinate
+ * @param sy Back buffer coordinate
  */
 void DrawDeadPlayer(int x, int y, int sx, int sy)
 {
@@ -415,8 +451,8 @@ void DrawDeadPlayer(int x, int y, int sx, int sy)
  * @brief Render an object sprite
  * @param x dPiece coordinate
  * @param y dPiece coordinate
- * @param ox Backbuffer coordinate
+ * @param ox Back buffer coordinate
- * @param oy Backbuffer coordinate
+ * @param oy Back buffer coordinate
  * @param pre Is the sprite in the background
  */
 static void DrawObject(int x, int y, int ox, int oy, BOOL pre)
@@ -470,6 +506,14 @@ static void DrawObject(int x, int y, int ox, int oy, BOOL pre)
 
 static void scrollrt_draw_dungeon(int sx, int sy, int dx, int dy, int eflag);
 
+/**
+ * @brief Render a row of tile
+ * @param x dPiece coordinate
+ * @param y dPiece coordinate
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param eflag is it an even (0) or odd (1) row
+ */
 static void drawRow(int x, int y, int sx, int sy, int eflag)
 {
 	BYTE *dst;
@@ -504,8 +548,8 @@ static void drawRow(int x, int y, int sx, int sy, int eflag)
  * @brief Re render tile to workaround sorting issues with players walking east/west
  * @param y dPiece coordinate
  * @param x dPiece coordinate
- * @param sx Backbuffer coordinate
+ * @param sx Back buffer coordinate
- * @param sy Backbuffer coordinate
+ * @param sy Back buffer coordinate
  */
 static void scrollrt_draw_e_flag(int x, int y, int sx, int sy)
 {
@@ -522,6 +566,14 @@ static void scrollrt_draw_e_flag(int x, int y, int sx, int sy)
 	level_piece_id = lpi_old;
 }
 
+/**
+ * @brief Draw item for a given tile
+ * @param y dPiece coordinate
+ * @param x dPiece coordinate
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param pre Is the sprite in the background
+ */
 static void DrawItem(int x, int y, int sx, int sy, BOOL pre)
 {
 	char bItem = dItem[x][y];
@@ -542,6 +594,15 @@ static void DrawItem(int x, int y, int sx, int sy, BOOL pre)
 	CelClippedDrawLight(px, sy, pItem->_iAnimData, pItem->_iAnimFrame, pItem->_iAnimWidth);
 }
 
+/**
+ * @brief Check if and how a mosnter should be rendered
+ * @param y dPiece coordinate
+ * @param x dPiece coordinate
+ * @param oy dPiece Y offset
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param eflag Should the sorting workaround be applied
+ */
 static void DrawMonsterHelper(int x, int y, int oy, int sx, int sy, int eflag)
 {
 	int mi, px, py;
@@ -587,6 +648,15 @@ static void DrawMonsterHelper(int x, int y, int oy, int sx, int sy, int eflag)
 	}
 }
 
+/**
+ * @brief Check if and how a player should be rendered
+ * @param y dPiece coordinate
+ * @param x dPiece coordinate
+ * @param oy dPiece Y offset
+ * @param sx Back buffer coordinate
+ * @param sy Back buffer coordinate
+ * @param eflag Should the sorting workaround be applied
+ */
 static void DrawPlayerHelper(int x, int y, int oy, int sx, int sy, int eflag)
 {
 	int p = dPlayer[x][y + oy];
@@ -608,8 +678,8 @@ static void DrawPlayerHelper(int x, int y, int oy, int sx, int sy, int eflag)
  * @brief Render object sprites
  * @param sx dPiece coordinate
  * @param sy dPiece coordinate
- * @param dx Backbuffer coordinate
+ * @param dx Back buffer coordinate
- * @param dy Backbuffer coordinate
+ * @param dy Back buffer coordinate
  * @param eflag Should the sorting workaround be applied
  */
 static void scrollrt_draw_dungeon(int sx, int sy, int dx, int dy, int eflag)
@@ -688,8 +758,8 @@ static void scrollrt_draw_dungeon(int sx, int sy, int dx, int dy, int eflag)
  * @brief Render a row of tile
  * @param x dPiece coordinate
  * @param y dPiece coordinate
- * @param sx Backbuffer coordinate
+ * @param sx Back buffer coordinate
- * @param sy Backbuffer coordinate
+ * @param sy Back buffer coordinate
  * @param chunks tile width of row
  * @param row current row being rendered
  */
@@ -1073,11 +1143,11 @@ static void DrawFPS()
 }
 
 /**
- * @brief Update part of the screen from the backbuffer
+ * @brief Update part of the screen from the back buffer
- * @param dwX Backbuffer coordinate
+ * @param dwX Back buffer coordinate
- * @param dwY Backbuffer coordinate
+ * @param dwY Back buffer coordinate
- * @param dwWdt Backbuffer coordinate
+ * @param dwWdt Back buffer coordinate
- * @param dwHgt Backbuffer coordinate
+ * @param dwHgt Back buffer coordinate
  */
 static void DoBlitScreen(DWORD dwX, DWORD dwY, DWORD dwWdt, DWORD dwHgt)
 {
@@ -1154,6 +1224,10 @@ static void DrawMain(int dwHgt, BOOL draw_desc, BOOL draw_hp, BOOL draw_mana, BO
 	}
 }
 
+/**
+ * @brief Redraw screen
+ * @param draw_cursor
+ */
 void scrollrt_draw_game_screen(BOOL draw_cursor)
 {
 	int hgt;