feat(screenshot): Add threaded JPEG/PNG screenshots without game stalls

CMakeLists.txt

@@ -65,6 +65,7 @@ endif()
 include(cmake/config.cmake)
 include(cmake/gamespy.cmake)
 include(cmake/lzhl.cmake)
+include(cmake/stb.cmake)
 
 if (IS_VS6_BUILD)
     # The original max sdk does not compile against a modern compiler.

Core/GameEngine/Include/Common/OptionPreferences.h

@@ -72,6 +72,7 @@ class OptionPreferences : public UserPreferences
 	Bool getRightMouseScrollWithAlternateMouseEnabled() const;
 	Bool getRetaliationModeEnabled();
 	Bool getDoubleClickAttackMoveEnabled();
+	Int getJPEGQuality();
 	Real getScrollFactor();
 	Bool getDrawScrollAnchor();
 	Bool getMoveScrollAnchor();

Core/GameEngine/Include/GameClient/Display.h

@@ -33,6 +33,12 @@
 #include "GameClient/GameFont.h"
 #include "GameClient/View.h"
 
+enum ScreenshotFormat
+{
+	SCREENSHOT_JPEG,
+	SCREENSHOT_PNG
+};
+
 struct ShroudLevel
 {
 	Short m_currentShroud;		///< A Value of 1 means shrouded.  0 is not.  Negative is the count of people looking.
@@ -172,7 +178,7 @@ class Display : public SubsystemInterface
 	virtual void preloadModelAssets( AsciiString model ) = 0;	///< preload model asset
 	virtual void preloadTextureAssets( AsciiString texture ) = 0;	///< preload texture asset
 
-	virtual void takeScreenShot() = 0;										///< saves screenshot to a file
+	virtual void takeScreenShot(ScreenshotFormat format) = 0;			///< saves screenshot in specified format
 	virtual void toggleMovieCapture() = 0;							///< starts saving frames to an avi or frame sequence
 	virtual void toggleLetterBox() = 0;										///< enabled letter-boxed display
 	virtual void enableLetterBox(Bool enable) = 0;						///< forces letter-boxed display on/off

Core/GameEngine/Source/Common/OptionPreferences.cpp

@@ -239,6 +239,16 @@ Bool OptionPreferences::getDoubleClickAttackMoveEnabled()
 	return FALSE;
 }
 
+Int OptionPreferences::getJPEGQuality()
+{
+	OptionPreferences::const_iterator it = find("JPEGQuality");
+	if (it == end())
+		return 80;
+
+	Int quality = atoi(it->second.str());
+	return clamp(1, quality, 100);
+}
+
 Real OptionPreferences::getScrollFactor()
 {
 	OptionPreferences::const_iterator it = find("ScrollFactor");

Core/GameEngine/Source/GameClient/MessageStream/CommandXlat.cpp

@@ -3738,7 +3738,15 @@ GameMessageDisposition CommandTranslator::translateGameMessage(const GameMessage
 		case GameMessage::MSG_META_TAKE_SCREENSHOT:
 		{
 			if (TheDisplay)
-				TheDisplay->takeScreenShot();
+				TheDisplay->takeScreenShot(SCREENSHOT_JPEG);
+			disp = DESTROY_MESSAGE;
+			break;
+		}
+
+		case GameMessage::MSG_META_TAKE_SCREENSHOT_PNG:
+		{
+			if (TheDisplay)
+				TheDisplay->takeScreenShot(SCREENSHOT_PNG);
 			disp = DESTROY_MESSAGE;
 			break;
 		}

Core/GameEngine/Source/GameClient/MessageStream/MetaEvent.cpp

@@ -171,6 +171,7 @@ static const LookupListRec GameMessageMetaTypeNames[] =
 	{ "END_PREFER_SELECTION",											GameMessage::MSG_META_END_PREFER_SELECTION },
 
 	{ "TAKE_SCREENSHOT",													GameMessage::MSG_META_TAKE_SCREENSHOT },
+	{ "TAKE_SCREENSHOT_PNG",											GameMessage::MSG_META_TAKE_SCREENSHOT_PNG },
 	{ "ALL_CHEER",																GameMessage::MSG_META_ALL_CHEER },
 
 	{ "BEGIN_CAMERA_ROTATE_LEFT",									GameMessage::MSG_META_BEGIN_CAMERA_ROTATE_LEFT },
@@ -945,6 +946,26 @@ void MetaMap::generateMetaMap()
 			map->m_usableIn = COMMANDUSABLE_GAME;
 		}
 	}
+	{
+		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_TAKE_SCREENSHOT);
+		if (map->m_key == MK_NONE)
+		{
+			map->m_key = MK_F12;
+			map->m_transition = DOWN;
+			map->m_modState = NONE;
+			map->m_usableIn = COMMANDUSABLE_EVERYWHERE;
+		}
+	}
+	{
+		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_TAKE_SCREENSHOT_PNG);
+		if (map->m_key == MK_NONE)
+		{
+			map->m_key = MK_F12;
+			map->m_transition = DOWN;
+			map->m_modState = CTRL;
+			map->m_usableIn = COMMANDUSABLE_EVERYWHERE;
+		}
+	}
 
 #if defined(RTS_DEBUG)
 	{

Core/GameEngineDevice/CMakeLists.txt

@@ -73,6 +73,7 @@ set(GAMEENGINEDEVICE_SRC
     Include/W3DDevice/GameClient/W3DTreeBuffer.h
     Include/W3DDevice/GameClient/W3DVideoBuffer.h
     Include/W3DDevice/GameClient/W3DView.h
+    Include/W3DDevice/GameClient/W3DScreenshot.h
 #    Include/W3DDevice/GameClient/W3DVolumetricShadow.h
     Include/W3DDevice/GameClient/W3DWater.h
     Include/W3DDevice/GameClient/W3DWaterTracks.h
@@ -175,6 +176,8 @@ set(GAMEENGINEDEVICE_SRC
     Source/W3DDevice/GameClient/W3DTreeBuffer.cpp
     Source/W3DDevice/GameClient/W3DVideoBuffer.cpp
     Source/W3DDevice/GameClient/W3DView.cpp
+#    Source/W3DDevice/GameClient/W3DScreenshot.cpp
+    Source/W3DDevice/GameClient/stb_image_write_impl.cpp
 #    Source/W3DDevice/GameClient/W3dWaypointBuffer.cpp
 #    Source/W3DDevice/GameClient/W3DWebBrowser.cpp
     Source/W3DDevice/GameClient/Water/W3DWater.cpp
@@ -220,6 +223,7 @@ target_include_directories(corei_gameenginedevice_public INTERFACE
 target_link_libraries(corei_gameenginedevice_private INTERFACE
     corei_always
     corei_main
+    stb
 )
 
 target_link_libraries(corei_gameenginedevice_public INTERFACE

Core/GameEngineDevice/Include/W3DDevice/GameClient/W3DScreenshot.h

@@ -0,0 +1,24 @@
+/*
+**	Command & Conquer Generals Zero Hour(tm)
+**	Copyright 2025 TheSuperHackers
+**
+**	This program is free software: you can redistribute it and/or modify
+**	it under the terms of the GNU General Public License as published by
+**	the Free Software Foundation, either version 3 of the License, or
+**	(at your option) any later version.
+**
+**	This program is distributed in the hope that it will be useful,
+**	but WITHOUT ANY WARRANTY; without even the implied warranty of
+**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+**	GNU General Public License for more details.
+**
+**	You should have received a copy of the GNU General Public License
+**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#include "GameClient/Display.h"
+
+void W3D_TakeCompressedScreenshot(ScreenshotFormat format, int quality = 0);
+

Core/GameEngineDevice/Source/W3DDevice/GameClient/stb_image_write_impl.cpp

@@ -0,0 +1,21 @@
+/*
+**	Command & Conquer Generals(tm)
+**	Copyright 2025 TheSuperHackers
+**
+**	This program is free software: you can redistribute it and/or modify
+**	it under the terms of the GNU General Public License as published by
+**	the Free Software Foundation, either version 3 of the License, or
+**	(at your option) any later version.
+**
+**	This program is distributed in the hope that it will be useful,
+**	but WITHOUT ANY WARRANTY; without even the implied warranty of
+**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+**	GNU General Public License for more details.
+**
+**	You should have received a copy of the GNU General Public License
+**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#define STB_IMAGE_WRITE_IMPLEMENTATION
+#include <stb_image_write.h>
+

Generals/Code/GameEngine/Include/Common/GlobalData.h

@@ -143,6 +143,7 @@ class GlobalData : public SubsystemInterface
 	Bool m_clientRetaliationModeEnabled;
 	Bool m_doubleClickAttackMove;
 	Bool m_rightMouseAlwaysScrolls;
+	Int m_jpegQuality;
 	Bool m_useWaterPlane;
 	Bool m_useCloudPlane;
 	Bool m_useShadowVolumes;

Generals/Code/GameEngine/Include/Common/MessageStream.h

@@ -256,7 +256,8 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_BEGIN_PREFER_SELECTION,						///< The Shift key has been depressed alone
 		MSG_META_END_PREFER_SELECTION,							///< The Shift key has been released.
 
-		MSG_META_TAKE_SCREENSHOT,										///< take screenshot
+		MSG_META_TAKE_SCREENSHOT,										///< take JPEG screenshot (F12)
+		MSG_META_TAKE_SCREENSHOT_PNG,							///< take PNG screenshot (CTRL+F12, lossless)
 		MSG_META_ALL_CHEER,													///< Yay! :)
 		MSG_META_TOGGLE_ATTACKMOVE,									///< enter attack-move mode
 

Generals/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -650,6 +650,7 @@ GlobalData::GlobalData()
 	m_enableDynamicLOD = TRUE;
 	m_enableStaticLOD = TRUE;
 	m_rightMouseAlwaysScrolls = FALSE;
+	m_jpegQuality = 80;
 	m_useWaterPlane = FALSE;
 	m_useCloudPlane = FALSE;
 	m_downwindAngle = ( -0.785f );//Northeast!
@@ -1198,6 +1199,7 @@ void GlobalData::parseGameDataDefinition( INI* ini )
 	TheWritableGlobalData->m_useRightMouseScrollWithAlternateMouse = optionPref.getRightMouseScrollWithAlternateMouseEnabled();
 	TheWritableGlobalData->m_clientRetaliationModeEnabled = optionPref.getRetaliationModeEnabled();
 	TheWritableGlobalData->m_doubleClickAttackMove = optionPref.getDoubleClickAttackMoveEnabled();
+	TheWritableGlobalData->m_jpegQuality = optionPref.getJPEGQuality();
 	TheWritableGlobalData->m_keyboardScrollFactor = optionPref.getScrollFactor();
 	TheWritableGlobalData->m_drawScrollAnchor = optionPref.getDrawScrollAnchor();
 	TheWritableGlobalData->m_moveScrollAnchor = optionPref.getMoveScrollAnchor();

Generals/Code/GameEngine/Source/Common/MessageStream.cpp

@@ -337,6 +337,7 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_BEGIN_PREFER_SELECTION)
 	CASE_LABEL(MSG_META_END_PREFER_SELECTION)
 	CASE_LABEL(MSG_META_TAKE_SCREENSHOT)
+	CASE_LABEL(MSG_META_TAKE_SCREENSHOT_PNG)
 	CASE_LABEL(MSG_META_ALL_CHEER)
 	CASE_LABEL(MSG_META_TOGGLE_ATTACKMOVE)
 	CASE_LABEL(MSG_META_BEGIN_CAMERA_ROTATE_LEFT)

Generals/Code/GameEngineDevice/CMakeLists.txt

@@ -139,6 +139,7 @@ set(GAMEENGINEDEVICE_SRC
     Source/W3DDevice/GameClient/W3DDebugDisplay.cpp
     Source/W3DDevice/GameClient/W3DDebugIcons.cpp
     Source/W3DDevice/GameClient/W3DDisplay.cpp
+    Source/W3DDevice/GameClient/W3DScreenshot.cpp
     Source/W3DDevice/GameClient/W3DDisplayString.cpp
     Source/W3DDevice/GameClient/W3DDisplayStringManager.cpp
     Source/W3DDevice/GameClient/W3DDynamicLight.cpp
@@ -200,6 +201,7 @@ target_link_libraries(g_gameenginedevice PRIVATE
     corei_gameenginedevice_private
     gi_always
     gi_main
+    stb
 )
 
 target_link_libraries(g_gameenginedevice PUBLIC

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

@@ -122,7 +122,7 @@ class W3DDisplay : public Display
 
 	virtual VideoBuffer*	createVideoBuffer() override;							///< Create a video buffer that can be used for this display
 
-	virtual void takeScreenShot() override;						//save screenshot to file
+	virtual void takeScreenShot(ScreenshotFormat format) override;	//save screenshot in specified format
 	virtual void toggleMovieCapture() override;			//enable AVI or frame capture mode.
 
 	virtual void toggleLetterBox() override;	///<enabled letter-boxed display