[GEN][ZH] Fix viewport scroll speed so it is independent of FPS in LookAtTranslator::translateGameMessage()

Author: Mauller

Generals/Code/GameEngine/Include/GameClient/Display.h

@@ -180,6 +180,7 @@ class Display : public SubsystemInterface
 	virtual void setCinematicTextFrames( Int frames ) { m_cinematicTextFrames = frames; }
 
 	virtual Real getAverageFPS( void ) = 0;	///< returns the average FPS.
+	virtual Real getCurrentFPS( void ) = 0;	///< returns the current FPS.
 	virtual Int getLastFrameDrawCalls( void ) = 0;  ///< returns the number of draw calls issued in the previous frame
 
 protected:

Generals/Code/GameEngine/Source/GameClient/MessageStream/LookAtXlat.cpp

@@ -471,6 +471,14 @@ GameMessageDisposition LookAtTranslator::translateGameMessage(const GameMessage
 					break;
 				}
 
+				// TheSuperHackers @bugfix Mauller 07/06/2025 Adjust the viewport scrolling so it is independent of gameClient FPS
+				// The scaling is based on the logic rate of 30 FPS, this provides a consistent scroll speed at all gameCLient FPS
+				// This also fixes scrolling within replays when fast forwarding due to the uncapped FPS
+				// When the FPS is in excess of the expected frame rate, the ratio will reduce the offset of the cameras movement
+				Real logicToFpsRatio = LOGICFRAMES_PER_SECONDS_REAL / TheDisplay->getCurrentFPS();
+				offset.x *= logicToFpsRatio;
+				offset.y *= logicToFpsRatio;
+
 				TheInGameUI->setScrollAmount(offset);
 				TheTacticalView->scrollBy( &offset );
 			}

Generals/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DDisplay.h

@@ -145,7 +145,8 @@ class W3DDisplay : public Display
 	static W3DAssetManager *m_assetManager;		///< W3D asset manager
 
 	void drawFPSStats( void );								///< draw the fps on the screen
-	virtual Real getAverageFPS( void );								///< return the average FPS.
+	virtual Real getAverageFPS( void );						///< return the average FPS.
+	virtual Real getCurrentFPS( void );						///< return the current FPS.
 	virtual Int getLastFrameDrawCalls( void );				///< returns the number of draw calls issued in the previous frame
 
 protected:
@@ -166,6 +167,7 @@ class W3DDisplay : public Display
 	IRegion2D m_clipRegion;									///< the clipping region for images
 	Bool m_isClippedEnabled;	///<used by 2D drawing operations to define clip re
 	Real m_averageFPS;		///<average fps over the last 30 frames.
+	Real m_currentFPS;		///<current fps value.
 #if defined(RTS_DEBUG) || defined(RTS_INTERNAL)
 	Int64 m_timerAtCumuFPSStart;
 #endif

Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DDisplay.cpp

@@ -832,8 +832,8 @@ void W3DDisplay::updateAverageFPS(void)
 		if (historyOffset >= FPS_HISTORY_SIZE)
 			historyOffset = 0;
 
-		double currentFPS = 1.0/elapsedSeconds; 
-		fpsHistory[historyOffset++] = currentFPS;
+		m_currentFPS = 1.0/elapsedSeconds; 
+		fpsHistory[historyOffset++] = m_currentFPS;
 		numSamples++;
 		if (numSamples > FPS_HISTORY_SIZE)
 			numSamples = FPS_HISTORY_SIZE;
@@ -1559,6 +1559,11 @@ Real W3DDisplay::getAverageFPS()
 	return m_averageFPS;
 }
 
+Real W3DDisplay::getCurrentFPS()
+{
+	return m_currentFPS;
+}
+
 Int W3DDisplay::getLastFrameDrawCalls()
 {
 	return Debug_Statistics::Get_Draw_Calls();

Generals/Code/Tools/GUIEdit/Include/GUIEditDisplay.h

@@ -126,6 +126,7 @@ class GUIEditDisplay : public Display
 #endif
 
 	virtual Real getAverageFPS(void) { return 0; }
+	virtual Real getCurrentFPS(void) { return 0; }
 	virtual Int getLastFrameDrawCalls( void ) { return 0; }
 
 protected:

GeneralsMD/Code/GameEngine/Include/GameClient/Display.h

@@ -181,6 +181,7 @@ class Display : public SubsystemInterface
 	virtual void setCinematicTextFrames( Int frames ) { m_cinematicTextFrames = frames; }
 
 	virtual Real getAverageFPS( void ) = 0;	///< returns the average FPS.
+	virtual Real getCurrentFPS( void ) = 0;	///< returns the current FPS.
 	virtual Int getLastFrameDrawCalls( void ) = 0;  ///< returns the number of draw calls issued in the previous frame
 
 protected:

GeneralsMD/Code/GameEngine/Source/GameClient/MessageStream/LookAtXlat.cpp

@@ -470,6 +470,14 @@ GameMessageDisposition LookAtTranslator::translateGameMessage(const GameMessage
 					break;
 				}
 
+				// TheSuperHackers @bugfix Mauller 07/06/2025 Adjust the viewport scrolling so it is independent of gameClient FPS
+				// The scaling is based on the logic rate of 30 FPS, this provides a consistent scroll speed at all gameCLient FPS
+				// This also fixes scrolling within replays when fast forwarding due to the uncapped FPS
+				// When the FPS is in excess of the expected frame rate, the ratio will reduce the offset of the cameras movement
+				Real logicToFpsRatio = LOGICFRAMES_PER_SECONDS_REAL / TheDisplay->getCurrentFPS();
+				offset.x *= logicToFpsRatio;
+				offset.y *= logicToFpsRatio;
+
 				TheInGameUI->setScrollAmount(offset);
 				TheTacticalView->scrollBy( &offset );
 			}

GeneralsMD/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DDisplay.h

@@ -146,7 +146,8 @@ class W3DDisplay : public Display
 	static W3DAssetManager *m_assetManager;		///< W3D asset manager
 
 	void drawFPSStats( void );								///< draw the fps on the screen
-	virtual Real getAverageFPS( void );								///< return the average FPS.
+	virtual Real getAverageFPS( void );						///< return the average FPS.
+	virtual Real getCurrentFPS( void );						///< return the current FPS.
 	virtual Int getLastFrameDrawCalls( void );				///< returns the number of draw calls issued in the previous frame
 
 protected:
@@ -167,6 +168,7 @@ class W3DDisplay : public Display
 	IRegion2D m_clipRegion;									///< the clipping region for images
 	Bool m_isClippedEnabled;	///<used by 2D drawing operations to define clip re
 	Real m_averageFPS;		///<average fps over the last 30 frames.
+	Real m_currentFPS;		///<current fps value.
 #if defined(RTS_DEBUG) || defined(RTS_INTERNAL)
 	Int64 m_timerAtCumuFPSStart;
 #endif

GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DDisplay.cpp

@@ -899,8 +899,8 @@ void W3DDisplay::updateAverageFPS(void)
 		if (historyOffset >= FPS_HISTORY_SIZE)
 			historyOffset = 0;
 
-		double currentFPS = 1.0/elapsedSeconds; 
-		fpsHistory[historyOffset++] = currentFPS;
+		m_currentFPS = 1.0/elapsedSeconds; 
+		fpsHistory[historyOffset++] = m_currentFPS;
 		numSamples++;
 		if (numSamples > FPS_HISTORY_SIZE)
 			numSamples = FPS_HISTORY_SIZE;
@@ -1647,6 +1647,11 @@ Real W3DDisplay::getAverageFPS()
 	return m_averageFPS;
 }
 
+Real W3DDisplay::getCurrentFPS()
+{
+	return m_currentFPS;
+}
+
 Int W3DDisplay::getLastFrameDrawCalls()
 {
 	return Debug_Statistics::Get_Draw_Calls();

GeneralsMD/Code/Tools/GUIEdit/Include/GUIEditDisplay.h

@@ -126,6 +126,7 @@ class GUIEditDisplay : public Display
 #endif
 
 	virtual Real getAverageFPS(void) { return 0; }
+	virtual Real getCurrentFPS(void) { return 0; }
 	virtual Int getLastFrameDrawCalls( void ) { return 0; }
 
 protected: