perf(radar): Reduce cost of radar pixel draw in PartitionManager::refreshShroudForLocalPlayer by 96% (#2072)

xezon · xezon · commit bd376c43dae8 · 2026-01-15T19:38:37.000+01:00
diff --git a/Core/GameEngine/Include/Common/Radar.h b/Core/GameEngine/Include/Common/Radar.h
@@ -218,8 +218,11 @@ class Radar : public Snapshot,
 	/// empty the entire shroud
 	virtual void clearShroud() = 0;
 
-	/// set the shroud level at shroud cell x,y
-	virtual void setShroudLevel( Int x, Int y, CellShroudStatus setting ) = 0;
+	/// TheSuperHackers @performance xezon 20/12/2025 Provides beginSetShroudLevel and endSetShroudLevel to improve performance.
+	/// Calling setShroudLevel many times is very expensive because it will lock a render resource on every call.
+	virtual void setShroudLevel( Int x, Int y, CellShroudStatus setting ) = 0; ///< set the shroud level at shroud cell x,y
+	virtual void beginSetShroudLevel() {} ///< call this once before multiple calls to setShroudLevel for better performance
+	virtual void endSetShroudLevel() {} ///< call this once after beginSetShroudLevel and setShroudLevel
 
 protected:
 
diff --git a/Core/GameEngineDevice/Include/W3DDevice/Common/W3DRadar.h b/Core/GameEngineDevice/Include/W3DDevice/Common/W3DRadar.h
@@ -37,6 +37,7 @@
 
 // FORWARD REFERENCES /////////////////////////////////////////////////////////////////////////////
 class TextureClass;
+class SurfaceClass;
 class TerrainLogic;
 
 // PROTOTYPES /////////////////////////////////////////////////////////////////////////////////////
@@ -63,7 +64,9 @@ class W3DRadar : public Radar
 	virtual void draw( Int pixelX, Int pixelY, Int width, Int height );		///< draw the radar
 
 	virtual void clearShroud();
-	virtual void setShroudLevel(Int x, Int y, CellShroudStatus setting);
+	virtual void setShroudLevel(Int x, Int y, CellShroudStatus setting); ///< set the shroud level at shroud cell x,y
+	virtual void beginSetShroudLevel(); ///< call this once before multiple calls to setShroudLevel for better performance
+	virtual void endSetShroudLevel(); ///< call this once after beginSetShroudLevel and setShroudLevel
 
 	virtual void refreshTerrain( TerrainLogic *terrain );
 	virtual void refreshObjects();
@@ -104,6 +107,10 @@ class W3DRadar : public Radar
 	WW3DFormat m_shroudTextureFormat;							///< format to use for shroud texture
 	Image *m_shroudImage;													///< shroud image abstraction for drawing
 	TextureClass *m_shroudTexture;								///< shroud texture
+	SurfaceClass *m_shroudSurface;								///< surface to shroud texture
+	void *m_shroudSurfaceBits;										///< shroud surface bits
+	int m_shroudSurfacePitch;											///< shroud surface pitch
+	UnsignedInt m_shroudSurfacePixelSize;					///< shroud surface pixel size
 
 	Int m_textureWidth;														///< width for all radar textures
 	Int m_textureHeight;													///< height for all radar textures
diff --git a/Core/GameEngineDevice/Source/W3DDevice/Common/System/W3DRadar.cpp b/Core/GameEngineDevice/Source/W3DDevice/Common/System/W3DRadar.cpp
@@ -54,6 +54,7 @@
 #include "W3DDevice/GameClient/W3DShroud.h"
 #include "WW3D2/texture.h"
 #include "WW3D2/dx8caps.h"
+#include "WWMath/vector2i.h"
 
 
 
@@ -132,7 +133,7 @@ void W3DRadar::initializeTextureFormats( void )
 }
 
 //-------------------------------------------------------------------------------------------------
-/** Delete resources used specifically in this W3D radar implemetation */
+/** Delete resources used specifically in this W3D radar implementation */
 //-------------------------------------------------------------------------------------------------
 void W3DRadar::deleteResources( void )
 {
@@ -167,6 +168,9 @@ void W3DRadar::deleteResources( void )
 	deleteInstance(m_shroudImage);
 	m_shroudImage = nullptr;
 
+	DEBUG_ASSERTCRASH(m_shroudSurface == NULL, ("W3DRadar::deleteResources: m_shroudSurface is expected NULL"));
+	DEBUG_ASSERTCRASH(m_shroudSurfaceBits == NULL, ("W3DRadar::deleteResources: m_shroudSurfaceBits is expected NULL"));
+
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -844,6 +848,10 @@ W3DRadar::W3DRadar( void )
 	m_shroudTextureFormat = WW3D_FORMAT_UNKNOWN;
 	m_shroudImage = nullptr;
 	m_shroudTexture = nullptr;
+	m_shroudSurface = nullptr;
+	m_shroudSurfaceBits = nullptr;
+	m_shroudSurfacePitch = 0;
+	m_shroudSurfacePixelSize = 0;
 
 	m_textureWidth = RADAR_CELL_WIDTH;
 	m_textureHeight = RADAR_CELL_HEIGHT;
@@ -1301,9 +1309,6 @@ void W3DRadar::setShroudLevel(Int shroudX, Int shroudY, CellShroudStatus setting
 	if (!shroud)
 		return;
 
-	SurfaceClass* surface = m_shroudTexture->Get_Surface_Level();
-	DEBUG_ASSERTCRASH( surface, ("W3DRadar: Can't get surface for Shroud texture") );
-
 	Int mapMinX = shroudX * shroud->getCellWidth();
 	Int mapMinY = shroudY * shroud->getCellHeight();
 	Int mapMaxX = (shroudX+1) * shroud->getCellWidth();
@@ -1315,21 +1320,19 @@ void W3DRadar::setShroudLevel(Int shroudX, Int shroudY, CellShroudStatus setting
 	worldPoint.x = mapMinX;
 	worldPoint.y = mapMinY;
 	worldToRadar( &worldPoint, &radarPoint );
-	Int radarMinX = radarPoint.x;
-	Int radarMinY = radarPoint.y;
+	const Int radarMinX = radarPoint.x;
+	const Int radarMinY = radarPoint.y;
 
 	worldPoint.x = mapMaxX;
 	worldPoint.y = mapMaxY;
 	worldToRadar( &worldPoint, &radarPoint );
-	Int radarMaxX = radarPoint.x;
-	Int radarMaxY = radarPoint.y;
+	const Int radarMaxX = radarPoint.x;
+	const Int radarMaxY = radarPoint.y;
 
-/*
-	Int radarMinX = REAL_TO_INT_FLOOR(mapMinX / getXSample());
-	Int radarMinY = REAL_TO_INT_FLOOR(mapMinY / getYSample());
-	Int radarMaxX = REAL_TO_INT_CEIL(mapMaxX / getXSample());
-	Int radarMaxY = REAL_TO_INT_CEIL(mapMaxY / getYSample());
-*/
+	// Int radarMinX = REAL_TO_INT_FLOOR(mapMinX / getXSample());
+	// Int radarMinY = REAL_TO_INT_FLOOR(mapMinY / getYSample());
+	// Int radarMaxX = REAL_TO_INT_CEIL(mapMaxX / getXSample());
+	// Int radarMaxY = REAL_TO_INT_CEIL(mapMaxY / getYSample());
 
 	/// @todo srj -- this really needs to smooth the display!
 
@@ -1343,15 +1346,69 @@ void W3DRadar::setShroudLevel(Int shroudX, Int shroudY, CellShroudStatus setting
 	else
 		alpha = 0;
 
-	for( Int y = radarMinY; y <= radarMaxY; y++ )
+	if (m_shroudSurface == NULL)
 	{
-		for( Int x = radarMinX; x <= radarMaxX; x++ )
+		// This is expensive.
+		SurfaceClass* surface = m_shroudTexture->Get_Surface_Level();
+		DEBUG_ASSERTCRASH( surface, ("W3DRadar: Can't get surface for Shroud texture") );
+
+		for( Int y = radarMinY; y <= radarMaxY; y++ )
 		{
-			if( legalRadarPoint( x, y ) )
+			for( Int x = radarMinX; x <= radarMaxX; x++ )
+			{
 				surface->DrawPixel( x, y, GameMakeColor( 0, 0, 0, alpha ) );
+			}
 		}
+		REF_PTR_RELEASE(surface);
 	}
-	REF_PTR_RELEASE(surface);
+	else
+	{
+		// This is cheap.
+		DEBUG_ASSERTCRASH(m_shroudSurfaceBits != NULL, ("W3DRadar::setShroudLevel: m_shroudSurfaceBits is not expected NULL"));
+		DEBUG_ASSERTCRASH(m_shroudSurfacePixelSize != 0, ("W3DRadar::setShroudLevel: m_shroudSurfacePixelSize is not expected 0"));
+		const Color color = GameMakeColor( 0, 0, 0, alpha );
+
+		for( Int y = radarMinY; y <= radarMaxY; ++y )
+		{
+			UnsignedByte* row = static_cast<UnsignedByte*>(m_shroudSurfaceBits) + y * m_shroudSurfacePitch;
+			for( Int x = radarMinX; x <= radarMaxX; ++x )
+			{
+				UnsignedByte* column = row + x * m_shroudSurfacePixelSize;
+
+				switch (m_shroudSurfacePixelSize)
+				{
+				case 1: *column = (UnsignedByte)(color & 0xFF); break;
+				case 2: *reinterpret_cast<UnsignedShort*>(column) = (UnsignedShort)(color & 0xFFFF); break;
+				case 4: *reinterpret_cast<UnsignedInt*>(column) = (UnsignedInt)color; break;
+				}
+			}
+		}
+	}
+}
+
+void W3DRadar::beginSetShroudLevel()
+{
+	DEBUG_ASSERTCRASH( m_shroudSurface == NULL, ("W3DRadar::beginSetShroudLevel: m_shroudSurface is expected NULL") );
+	m_shroudSurface = m_shroudTexture->Get_Surface_Level();
+	DEBUG_ASSERTCRASH( m_shroudSurface != NULL, ("W3DRadar::beginSetShroudLevel: Can't get surface for Shroud texture") );
+
+	SurfaceClass::SurfaceDescription sd;
+	m_shroudSurface->Get_Description(sd);
+	m_shroudSurfaceBits = m_shroudSurface->Lock(&m_shroudSurfacePitch);
+	m_shroudSurfacePixelSize = Get_Bytes_Per_Pixel(sd.Format);
+}
+
+void W3DRadar::endSetShroudLevel()
+{
+	DEBUG_ASSERTCRASH( m_shroudSurface != NULL, ("W3DRadar::endSetShroudLevel: m_shroudSurface is not expected NULL") );
+	if (m_shroudSurfaceBits != NULL)
+	{
+		m_shroudSurface->Unlock();
+		m_shroudSurfaceBits = NULL;
+		m_shroudSurfacePitch = 0;
+		m_shroudSurfacePixelSize = 0;
+	}
+	REF_PTR_RELEASE(m_shroudSurface);
 }
 
 //-------------------------------------------------------------------------------------------------
diff --git a/Core/Libraries/Source/WWVegas/WW3D2/surfaceclass.cpp b/Core/Libraries/Source/WWVegas/WW3D2/surfaceclass.cpp
@@ -205,7 +205,7 @@ void SurfaceClass::Get_Description(SurfaceDescription &surface_desc)
 	surface_desc.Width = d3d_desc.Width;
 }
 
-void * SurfaceClass::Lock(int * pitch)
+void *SurfaceClass::Lock(int *pitch)
 {
 	D3DLOCKED_RECT lock_rect;
 	::ZeroMemory(&lock_rect, sizeof(D3DLOCKED_RECT));
@@ -214,6 +214,22 @@ void * SurfaceClass::Lock(int * pitch)
 	return (void *)lock_rect.pBits;
 }
 
+void *SurfaceClass::Lock(int *pitch, const Vector2i &min, const Vector2i &max)
+{
+	D3DLOCKED_RECT lock_rect;
+	::ZeroMemory(&lock_rect, sizeof(D3DLOCKED_RECT));
+
+	RECT rect;
+	rect.left = min.I;
+	rect.top = min.J;
+	rect.right = max.I;
+	rect.bottom = max.J;
+	DX8_ErrorCode(D3DSurface->LockRect(&lock_rect, &rect, 0));
+
+	*pitch = lock_rect.Pitch;
+	return (void *)lock_rect.pBits;
+}
+
 void SurfaceClass::Unlock(void)
 {
 	DX8_ErrorCode(D3DSurface->UnlockRect());
@@ -312,7 +328,7 @@ void SurfaceClass::Copy(const unsigned char *other)
  * HISTORY:                                                                                    *
  *   5/2/2001   hy : Created.                                                                  *
  *=============================================================================================*/
-void SurfaceClass::Copy(Vector2i &min,Vector2i &max, const unsigned char *other)
+void SurfaceClass::Copy(const Vector2i &min, const Vector2i &max, const unsigned char *other)
 {
 	SurfaceDescription sd;
 	Get_Description(sd);
diff --git a/Core/Libraries/Source/WWVegas/WW3D2/surfaceclass.h b/Core/Libraries/Source/WWVegas/WW3D2/surfaceclass.h
@@ -79,7 +79,8 @@ class SurfaceClass : public W3DMPO, public RefCountClass
 		 void Get_Description(SurfaceDescription &surface_desc);
 
 		// Lock / unlock the surface
-		void * Lock(int * pitch);
+		void *Lock(int *pitch);
+		void *Lock(int *pitch, const Vector2i &min, const Vector2i &max);
 		void Unlock(void);
 
 		// HY -- The following functions are support functions for font3d
@@ -97,7 +98,7 @@ class SurfaceClass : public W3DMPO, public RefCountClass
 		void Copy(const unsigned char *other);
 
 		// support for copying from a byte array
-		void Copy(Vector2i &min,Vector2i &max, const unsigned char *other);
+		void Copy(const Vector2i &min, const Vector2i &max, const unsigned char *other);
 
 		// copies the contents of one surface to another, stretches
 		void Stretch_Copy(
diff --git a/Generals/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp b/Generals/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp
@@ -3047,15 +3047,21 @@ void PartitionManager::refreshShroudForLocalPlayer()
 	TheDisplay->clearShroud();
 	TheRadar->clearShroud();
 
-	const Int playerIndex = rts::getObservedOrLocalPlayer()->getPlayerIndex();
-	for (int i = 0; i < m_totalCellCount; ++i)
+	if (m_totalCellCount != 0)
 	{
-		Int x = m_cells[i].getCellX();
-		Int y = m_cells[i].getCellY();
-		CellShroudStatus status = m_cells[i].getShroudStatusForPlayer(playerIndex);
-		TheDisplay->setShroudLevel(x, y, status);
-		TheRadar->setShroudLevel(x, y, status);
-		m_cells[i].invalidateShroudedStatusForAllCois(playerIndex);
+		const Int playerIndex = rts::getObservedOrLocalPlayer()->getPlayerIndex();
+		TheRadar->beginSetShroudLevel();
+
+		for (int i = 0; i < m_totalCellCount; ++i)
+		{
+			const Int x = m_cells[i].getCellX();
+			const Int y = m_cells[i].getCellY();
+			const CellShroudStatus status = m_cells[i].getShroudStatusForPlayer(playerIndex);
+			TheDisplay->setShroudLevel(x, y, status);
+			TheRadar->setShroudLevel(x, y, status);
+			m_cells[i].invalidateShroudedStatusForAllCois(playerIndex);
+		}
+		TheRadar->endSetShroudLevel();
 	}
 }
 
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp
@@ -3054,15 +3054,21 @@ void PartitionManager::refreshShroudForLocalPlayer()
 	TheDisplay->clearShroud();
 	TheRadar->clearShroud();
 
-	const Int playerIndex = rts::getObservedOrLocalPlayer()->getPlayerIndex();
-	for (int i = 0; i < m_totalCellCount; ++i)
+	if (m_totalCellCount != 0)
 	{
-		Int x = m_cells[i].getCellX();
-		Int y = m_cells[i].getCellY();
-		CellShroudStatus status = m_cells[i].getShroudStatusForPlayer(playerIndex);
-		TheDisplay->setShroudLevel(x, y, status);
-		TheRadar->setShroudLevel(x, y, status);
-		m_cells[i].invalidateShroudedStatusForAllCois(playerIndex);
+		const Int playerIndex = rts::getObservedOrLocalPlayer()->getPlayerIndex();
+		TheRadar->beginSetShroudLevel();
+
+		for (int i = 0; i < m_totalCellCount; ++i)
+		{
+			const Int x = m_cells[i].getCellX();
+			const Int y = m_cells[i].getCellY();
+			const CellShroudStatus status = m_cells[i].getShroudStatusForPlayer(playerIndex);
+			TheDisplay->setShroudLevel(x, y, status);
+			TheRadar->setShroudLevel(x, y, status);
+			m_cells[i].invalidateShroudedStatusForAllCois(playerIndex);
+		}
+		TheRadar->endSetShroudLevel();
 	}
 }
 
