Merge pull request #194 from cortex-command-community/Multi-Screen-Handling

Multi-screen resolution handling

Author: garethyr

CHANGELOG.md

@@ -217,8 +217,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 	**Note:** Changing the game window resolution while an Activity is active requires ending the Activity. A dialog box will appear asking to confirm the change.
 
-- Moved from C-style random number generation to C++ standard. This includes usage of an mt19937 random number generator.
-- For C++ coders the functions SelectRand, PosRand and RangeRand have been replaced by the function template RandomNum() and its overload RandomNum(T min, T max). The function NormalRand has been replaced by the function template RandomNormalNum(). For lua coders there is no change.
+- Moved from C-style random number generation to C++ standard. This includes usage of an mt19937 random number generator.  
+	For C++ coders the functions SelectRand, PosRand and RangeRand have been replaced by the function template RandomNum() and its overload RandomNum(T min, T max). The function NormalRand has been replaced by the function template RandomNormalNum(). For lua coders there is no change.
+	
+- Resolution validation changed to support multiple screens. Incompatible/bad resolution settings will be overridden at startup with messages explaining the issue.  
+	**Note:** For multi-screen to work properly, the left-most screen MUST be set as primary. Screens having different resolutions does not actually matter but different heights will still be warned about and overridden due to the likeliness of GUI elementes being cropped on the shortest screen.  
+	Resolution validation can be disabled for multi-screen setups with `Settings.ini` property `DisableMultiScreenResolutionValidation`. Bad settings are likely to crash, use at own risk.  
+	For setups with more than 3 screens `DisableMultiScreenResolutionValidation` must be set true.
 
 - Damage to actors from impulses is now relative to their max health instead of being on a scale from 0 to 100.
 

Managers/FrameMan.cpp

@@ -32,8 +32,12 @@ namespace RTE {
 
 	void FrameMan::Clear() {
 		m_GfxDriver = GFX_AUTODETECT_WINDOWED;
-		m_ScreenResX = GetSystemMetrics(SM_CXSCREEN);
-		m_ScreenResY = GetSystemMetrics(SM_CYSCREEN);
+		m_DisableMultiScreenResolutionValidation = false;
+		m_NumScreens = GetSystemMetrics(SM_CMONITORS);
+		m_ScreenResX = GetSystemMetrics(SM_CXVIRTUALSCREEN);
+		m_ScreenResY = GetSystemMetrics(SM_CYVIRTUALSCREEN);
+		m_PrimaryScreenResX = GetSystemMetrics(SM_CXSCREEN);
+		m_PrimaryScreenResY = GetSystemMetrics(SM_CYSCREEN);
 		m_ResX = 960;
 		m_ResY = 540;
 		m_NewResX = m_ResX;
@@ -124,14 +128,75 @@ namespace RTE {
 		} else if ((resX * resMultiplier) % 4 > 0) {
 			allegro_message("Resolution width that is not divisible by 4 is not supported!\nOverriding to closest valid width!");
 			resX = m_NewResX = std::floor(resX / 4) * 4;
-		} else {
+		}
+
+		if (m_NumScreens == 1) {
 			float currentAspectRatio = static_cast<float>(resX) / static_cast<float>(resY);
 			if (currentAspectRatio < 1 || currentAspectRatio > 4) {
 				allegro_message("Abnormal aspect ratio detected! Reverting to defaults!");
 				resX = m_NewResX = 960;
 				resY = m_NewResY = 540;
 				resMultiplier = m_ResMultiplier = m_NewResMultiplier = 1;
 			}
+		} else if (!m_DisableMultiScreenResolutionValidation && m_NumScreens > 1 && m_NumScreens < 4) {
+			if (resX * resMultiplier > m_PrimaryScreenResX || resY * resMultiplier > m_PrimaryScreenResY) { ValidateMultiScreenResolution(resX, resY, resMultiplier); }
+		} else if (!m_DisableMultiScreenResolutionValidation && m_NumScreens > 3) {
+			allegro_message("Number of screens is too damn high! Overriding to defaults!\n\nPlease disable multi-screen resolution validation in \"Settings.ini\" and run at your own risk!");
+			resX = m_NewResX = 960;
+			resY = m_NewResY = 540;
+			resMultiplier = m_ResMultiplier = m_NewResMultiplier = 1;
+		}
+
+		g_SettingsMan.UpdateSettingsFile();
+	}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	void FrameMan::ValidateMultiScreenResolution(unsigned short &resX, unsigned short &resY, unsigned short &resMultiplier) {
+		POINT pointOnScreen;
+		HMONITOR screenHandle;
+		MONITORINFO screenInfo;
+
+		pointOnScreen = { -1 , 0 };
+		screenHandle = MonitorFromPoint(pointOnScreen, MONITOR_DEFAULTTONULL);
+		if (screenHandle != NULL) {
+			const char *leftNotPrimaryMessage = {
+				"Due to limitations in Cortex Command's graphics API it is impossible to properly run multi-screen mode when the left-most screen is not set as primary.\n"
+				"Please configure your left-most screen to be primary to utilize all screens, as the game window will extend right but will not extend left, leaving any screen left of the primary unused.\n\n"
+				"You can disable multi-screen resolution validation in \"Settings.ini\" and run at your own risk!\n\nResolution settings will be overridden to fit primary screen only!"
+			};
+			allegro_message(leftNotPrimaryMessage);
+			resX = m_NewResX = m_PrimaryScreenResX / resMultiplier;
+			resY = m_NewResY = m_PrimaryScreenResY / resMultiplier;
+			return;
+		}
+
+		pointOnScreen = { m_PrimaryScreenResX + 1 , 0 };
+		screenHandle = MonitorFromPoint(pointOnScreen, MONITOR_DEFAULTTONULL);
+		screenInfo = { sizeof(MONITORINFO) };
+		GetMonitorInfo(screenHandle, &screenInfo);
+		unsigned short centerScreenResY = screenInfo.rcMonitor.bottom;
+
+		if (centerScreenResY != m_PrimaryScreenResY) {
+			allegro_message("Center screen height is not identical to primary screen, overriding to fit primary screen only!\n\nYou can disable multi-screen resolution validation in \"Settings.ini\" and run at your own risk!");
+			resX = m_NewResX = m_PrimaryScreenResX / resMultiplier;
+			resY = m_NewResY = m_PrimaryScreenResY / resMultiplier;
+			return;
+		}
+
+		if (m_NumScreens == 3) {
+			pointOnScreen = { screenInfo.rcMonitor.right + 1 , 0 };
+			screenHandle = MonitorFromPoint(pointOnScreen, MONITOR_DEFAULTTONULL);
+			screenInfo = { sizeof(MONITORINFO) };
+			GetMonitorInfo(screenHandle, &screenInfo);
+			unsigned short rightScreenResY = screenInfo.rcMonitor.bottom;
+
+			if (rightScreenResY != m_PrimaryScreenResY) {
+				allegro_message("Right screen height is not identical to primary screen, overriding to extend to center screen only!\n\nYou can disable multi-screen resolution validation in \"Settings.ini\" and run at your own risk!");
+				resX = m_NewResX = (m_ScreenResX - (screenInfo.rcMonitor.right - screenInfo.rcMonitor.left)) / resMultiplier;
+				resY = m_NewResY = m_PrimaryScreenResY / resMultiplier;
+				return;
+			}
 		}
 	}
 
@@ -260,6 +325,8 @@ namespace RTE {
 			m_NewResY = m_ResY;
 		} else if (propName == "ResolutionMultiplier") {
 			reader >> m_ResMultiplier;
+		} else if (propName == "DisableMultiScreenResolutionValidation") {
+			reader >> m_DisableMultiScreenResolutionValidation;
 		} else if (propName == "HSplitScreen") {
 			reader >> m_HSplitOverride;
 		} else if (propName == "VSplitScreen") {
@@ -281,6 +348,10 @@ namespace RTE {
 		writer << m_ResX;
 		writer.NewProperty("ResolutionY");
 		writer << m_ResY;
+		writer.NewProperty("ResolutionMultiplier");
+		writer << m_ResMultiplier;
+		writer.NewProperty("DisableMultiScreenResolutionValidation");
+		writer << m_DisableMultiScreenResolutionValidation;
 		writer.NewProperty("HSplitScreen");
 		writer << m_HSplitOverride;
 		writer.NewProperty("VSplitScreen");

Managers/FrameMan.h

@@ -143,6 +143,12 @@ namespace RTE {
 		/// <returns>What multiple the screen resolution is run in (1 normal).</returns>
 		unsigned short ResolutionMultiplier() const { return m_ResMultiplier; }
 
+		/// <summary>
+		/// Gets whether resolution validation in multi-screen mode is disabled or not.
+		/// </summary>
+		/// <returns>Whether resolution validation in multi-screen mode is disabled or not.</returns>
+		bool IsMultiScreenResolutionValidationDisabled() const { return m_DisableMultiScreenResolutionValidation; }
+
 		/// <summary>
 		/// Sets and switches to a new windowed mode resolution multiplier.
 		/// </summary>
@@ -551,8 +557,13 @@ namespace RTE {
 
 		int m_GfxDriver; //!< The graphics driver that will be used for rendering.
 
-		unsigned short m_ScreenResX; //!< Width of the physical screen (desktop resolution). 
-		unsigned short m_ScreenResY; //!< Height of the physical screen (desktop resolution).
+		bool m_DisableMultiScreenResolutionValidation; //!< Whether to disable resolution validation when running multi-screen mode or not. Allows setting whatever crazy resolution that may or may not crash.
+
+		unsigned short m_NumScreens; //!< Number of physical screens.
+		unsigned short m_ScreenResX; //!< Width of the primary or all physical screens combined if more than one available (desktop resolution). 
+		unsigned short m_ScreenResY; //!< Height of the primary or tallest screen if more than one available (desktop resolution).
+		unsigned short m_PrimaryScreenResX; //!< Width of the primary physical screen only.
+		unsigned short m_PrimaryScreenResY; //!< Height of the primary physical screen only.
 
 		unsigned short m_ResX; //!< Game window width.
 		unsigned short m_ResY; //!< Game window height.
@@ -666,6 +677,14 @@ namespace RTE {
 		/// <param name="resMultiplier">Game window resolution multiplier to check.</param>
 		void ValidateResolution(unsigned short &resX, unsigned short &resY, unsigned short &resMultiplier);
 
+		/// <summary>
+		/// Checks whether the passed in multi-screen resolution settings make sense. If not, overrides them to prevent crashes or unexpected behavior. This is called during ValidateResolution().
+		/// </summary>
+		/// <param name="resX">Game window width to check.</param>
+		/// <param name="resY">Game window height to check.</param>
+		/// <param name="resMultiplier">Game window resolution multiplier to check.</param>
+		void ValidateMultiScreenResolution(unsigned short &resX, unsigned short &resY, unsigned short &resMultiplier);
+
 		/// <summary>
 		/// Creates all the frame buffer bitmaps to be used by FrameMan. This is called during Create().
 		/// </summary>

Managers/SettingsMan.cpp

@@ -107,6 +107,8 @@ namespace RTE {
 			g_FrameMan.ReadProperty(propName, reader);
 		} else if (propName == "ResolutionMultiplier") {
 			g_FrameMan.ReadProperty(propName, reader);
+		} else if (propName == "DisableMultiScreenResolutionValidation") {
+			g_FrameMan.ReadProperty(propName, reader);
 		} else if (propName == "HSplitScreen") {
 			g_FrameMan.ReadProperty(propName, reader);
 		} else if (propName == "VSplitScreen") {
@@ -265,6 +267,8 @@ namespace RTE {
 		writer << g_FrameMan.GetNewResY();
 		writer.NewProperty("ResolutionMultiplier");
 		writer << g_FrameMan.ResolutionMultiplier();
+		writer.NewProperty("DisableMultiScreenResolutionValidation");
+		writer << g_FrameMan.IsMultiScreenResolutionValidationDisabled();
 		writer.NewProperty("HSplitScreen");
 		writer << g_FrameMan.GetHSplit();
 		writer.NewProperty("VSplitScreen");
@@ -490,6 +494,8 @@ namespace RTE {
 		writer << 540;
 		writer.NewProperty("ResolutionMultiplier");
 		writer << 1;
+		writer.NewProperty("DisableMultiScreenResolutionValidation");
+		writer << 0;
 		writer.NewProperty("SoundVolume");
 		writer << 40;
 		writer.NewProperty("MusicVolume");

Menus/MainMenuGUI.cpp

@@ -1142,8 +1142,7 @@ void MainMenuGUI::Update()
 					g_SettingsMan.SetShowToolTips(m_aOptionsCheckbox[SHOWTOOLTIPS]->GetCheck());
 					g_SettingsMan.SetPreciseCollisions(m_aOptionsCheckbox[PRECISECOLLISIONS]->GetCheck());
 
-					Writer writer("Base.rte/Settings.ini");
-                    g_SettingsMan.Save(writer);
+					g_SettingsMan.UpdateSettingsFile();
 				}
 
                 m_MenuScreen = MAINSCREEN;
@@ -1528,8 +1527,7 @@ void MainMenuGUI::Update()
 				if (anEvent.GetControl() == m_pModManagerBackButton)
 				{
 					// Save settings
-					Writer writer("Base.rte/Settings.ini");
-					g_SettingsMan.Save(writer);
+					g_SettingsMan.UpdateSettingsFile();
 
 					// Hide all screens, the appropriate screen will reappear on next update
 					HideAllScreens();