Merge pull request #96 from cortex-command-community/FrameMan-Breakdown

FrameMan Breakdown

Author: garethyr

Activities/ActorEditor.cpp

@@ -339,7 +339,7 @@ void ActorEditor::DrawGUI(BITMAP *pTargetBitmap, const Vector &targetPos, int wh
     }
 
     // Clear out annoying blooms
-    g_SceneMan.ClearPostEffects();
+    g_PostProcessMan.ClearScenePostEffects();
 
     m_pPicker->Draw(pTargetBitmap);
     m_pPieMenu->Draw(pTargetBitmap, targetPos);

Activities/EditorActivity.cpp

@@ -209,7 +209,7 @@ int EditorActivity::Start()
         return error;
 
     // Clear the post effects
-    g_SceneMan.ClearPostEffects();
+	g_PostProcessMan.ClearScenePostEffects();
 
     // Clear the screen messages
     g_FrameMan.ClearScreenText();

Activities/EditorActivity.h

@@ -17,6 +17,7 @@
 #include "GUISound.h"
 #include "RTETools.h"
 #include "ActivityMan.h"
+#include "PostProcessMan.h"
 
 namespace RTE
 {

Activities/GameActivity.cpp

@@ -20,6 +20,7 @@
 #include "ConsoleMan.h"
 #include "PresetMan.h"
 #include "DataModule.h"
+#include "PostProcessMan.h"
 #include "Controller.h"
 #include "Scene.h"
 #include "Actor.h"
@@ -2141,7 +2142,7 @@ void GameActivity::Update()
 
 void GameActivity::DrawGUI(BITMAP *pTargetBitmap, const Vector &targetPos, int which)
 {
-    if (which < 0 || which >= MAXSCREENCOUNT)
+    if (which < 0 || which >= c_MaxScreenCount)
         return;
 
     char str[512];
@@ -2374,7 +2375,7 @@ void GameActivity::DrawGUI(BITMAP *pTargetBitmap, const Vector &targetPos, int w
         Vector center = m_ActorCursor[PoS] - targetPos;
         circle(pTargetBitmap, center.m_X, center.m_Y, m_CursorTimer.AlternateReal(150) ? 6 : 8, g_YellowGlowColor);
         // Add pixel glow area around it, in scene coordinates
-        g_SceneMan.RegisterGlowArea(m_ActorCursor[PoS], 10);
+		g_PostProcessMan.RegisterGlowArea(m_ActorCursor[PoS], 10);
 /* Crosshairs
         putpixel(pTargetBitmap, center.m_X, center.m_Y, g_YellowGlowColor);
         hline(pTargetBitmap, center.m_X - 5, center.m_Y, center.m_X - 2, g_YellowGlowColor);
@@ -2391,7 +2392,7 @@ void GameActivity::DrawGUI(BITMAP *pTargetBitmap, const Vector &targetPos, int w
         circlefill(pTargetBitmap, center.m_X, center.m_Y, 2, g_YellowGlowColor);
 //            putpixel(pTargetBitmap, center.m_X, center.m_Y, g_YellowGlowColor);
         // Add pixel glow area around it, in scene coordinates
-        g_SceneMan.RegisterGlowArea(m_ActorCursor[PoS], 10);
+		g_PostProcessMan.RegisterGlowArea(m_ActorCursor[PoS], 10);
 
         // Draw a line from the last set waypoint to the cursor
         if (m_pControlledActor[PoS] && g_MovableMan.IsActor(m_pControlledActor[PoS]))
@@ -2473,13 +2474,13 @@ void GameActivity::DrawGUI(BITMAP *pTargetBitmap, const Vector &targetPos, int w
 						unwrappedPos = m_ActorCursor[PoS] + Vector(sceneWidth , 0);
 					else
 						unwrappedPos = m_ActorCursor[PoS] - Vector(sceneWidth , 0);
-					g_SceneMan.RegisterGlowArea(unwrappedPos, 10);
+					g_PostProcessMan.RegisterGlowArea(unwrappedPos, 10);
 				}
 			}
 			else
 				unwrappedPos = m_ActorCursor[PoS];
 
-			g_SceneMan.RegisterGlowArea(m_ActorCursor[PoS], 10);
+			g_PostProcessMan.RegisterGlowArea(m_ActorCursor[PoS], 10);
 
 			//Glowing dotted circle version
 			int dots = 2 * c_PI * radius / 25;//5 + (int)(radius / 10);
@@ -2519,7 +2520,7 @@ void GameActivity::DrawGUI(BITMAP *pTargetBitmap, const Vector &targetPos, int w
 					}
 
 					circlefill(pTargetBitmap, dotDrawPos.m_X, dotDrawPos.m_Y, 1, g_YellowGlowColor);
-					g_SceneMan.RegisterGlowArea(dotPos, 3);
+					g_PostProcessMan.RegisterGlowArea(dotPos, 3);
 				}
 			}
 		}

Activities/MultiplayerServerLobby.cpp

@@ -350,7 +350,7 @@ namespace RTE {
 		ContentFile defaultPreview("Base.rte/GUIs/DefaultPreview.bmp");
 		m_pDefaultPreviewBitmap = defaultPreview.LoadAndReleaseBitmap();
 
-		clear_to_color(m_pScenePreviewBitmap, g_KeyColor);
+		clear_to_color(m_pScenePreviewBitmap, g_MaskColor);
 
 		m_apPlayerIcons[0] = dynamic_cast<const Icon *>(g_PresetMan.GetEntityPreset("Icon", "Device Gamepad 1"));
 		m_apPlayerIcons[1] = dynamic_cast<const Icon *>(g_PresetMan.GetEntityPreset("Icon", "Device Gamepad 2"));
@@ -1316,7 +1316,7 @@ namespace RTE {
 		BITMAP * drawBitmap = m_pUIDrawBitmap;
 		BITMAP * finalDestBitmap = 0;
 
-		clear_to_color(drawBitmap, g_KeyColor);
+		clear_to_color(drawBitmap, g_MaskColor);
 
 		// Store offset set for player 0
 		int baseOffsetX = m_pRootBox->GetXPos();

CHANGELOG.md

@@ -22,6 +22,8 @@ Valid editor names are: `ActorEditor`, `GibEditor`, `SceneEditor`, `AreaEditor`
 		YourKeyName = YourStringValue
 	```
 	`YourKeyName` is a string value and is not limited to just numbers.
+	
+- New `Settings.ini` property `AdvancedPerformanceStats = 0/1` to disable/enable the performance counter graphs (enabled by default).
 
 ### Changed
 
@@ -54,6 +56,27 @@ They must be added using `... = SoundContainer`, and individual sounds for them
 		...
 	```
 
+- `FrameMan` broken down to 4 managers. New managers are:  
+`PerformanceMan` to handle all performance stats and measurements.  
+`PostProcessMan` to handle all post-processing (glows).  
+`PrimitiveMan` to handle all lua primitive drawing.
+
+- Post-processing (glow effects) is now enabled at all times with no option to disable.
+
+- All lua primitive draw calls are now called from `PrimitiveMan`.  
+For example: `FrameMan:DrawLinePrimitive()` is now `PrimitiveMan:DrawLinePrimitive()`.
+
+- Resolution multiplier properties (`NxWindowed` and `NxFullscreen`) in settings merged into a single property `ResolutionMultiplier`.
+
+- Incompatible/bad resolution settings will be overriden at startup with messages expaining the issue instead of multiple mode switches and eventually a reset to default VGA.  
+Reset to defaults (now 960x540) will happen only on horrible aspect ratio or if you managed to really destroy something.
+
+- You can no longer toggle native fullscreen mode from the settings menu or ini. Instead, either select your desktop resolution at 1X mode or desktop resolution divided by 2 at 2X mode for borderless fullscreen windowed mode.  
+Due to limitations in Allegro 4, changing the actual resolution from within the game still requires a restart.
+
+- If the current game resolution is half the desktop resolution or less, you will be able to instantly switch between 1X and 2X resolution multiplier modes in the settings without screen flicker or delay.  
+If the conditions are not met, the mode switch button will show `Unavailable`.
+
 ### Fixed
 
 - Fixed LuaBind being all sorts of messed up. All lua bindings now work properly like they were before updating to the v141 toolset.
@@ -78,6 +101,18 @@ They must be added using `... = SoundContainer`, and individual sounds for them
 
 - Removed all OSX/Linux related code and files because we don't care. See [Liberated Cortex](https://github.com/liberated-cortex) for working Linux port.
 
+- Removed a bunch of low-level `FrameMan` lua bindings:  
+`FrameMan:ResetSplitScreens`, `FrameMan:PPM` setter, `FrameMan:ResX/Y`, `FrameMan:HSplit/VSplit`, `FrameMan:GetPlayerFrameBufferWidth/Height`, `FrameMan:IsFullscreen`, `FrameMan:ToggleFullScreen`, 
+`FrameMan:ClearBackbuffer8/32`, `FrameMan:ClearPostEffects`, `FrameMan:ResetFrameTimer`, `FrameMan:ShowPerformanceStats`.
+
+- Native fullscreen mode has been removed due to poor performance compared to windowed/borderless mode and various input device issues.  
+The version of Allegro we're running is pretty old now (released in 2007) and probably doesn't properly support/utilize newer features and APIs leading to these issues.  
+The minimal amount of hardware acceleration CC has is still retained through Windows' DWM and that evidently does a better job.
+
+- Removed now obsolete `Settings.ini` properties:  
+Post-processing: `TrueColorMode`, `PostProcessing`, `PostPixelGlow`.   
+Native fullscreen mode: `Fullscreen`, `NxWindowed`, `NxFullscreen`, `ForceSoftwareGfxDriver`, `ForceSafeGfxDriver`.
+
 ***
 
 ## [0.0.1.0] - 2020-01-27

Entities/AEmitter.cpp

@@ -655,7 +655,7 @@ void AEmitter::Draw(BITMAP *pTargetBitmap,
         emitPos.RadRotate(m_HFlipped ? c_PI + m_Rotation.GetRadAngle() - m_EmitAngle.GetRadAngle() : m_Rotation.GetRadAngle() + m_EmitAngle.GetRadAngle());
         emitPos = m_Pos + RotateOffset(m_EmissionOffset) + emitPos;
         if(!g_SceneMan.ObscuredPoint(emitPos))
-            g_SceneMan.RegisterPostEffect(emitPos, m_pFlash->GetScreenEffect(), m_pFlash->GetScreenEffectHash(), 55 + 200 * PosRand(), m_pFlash->GetEffectRotAngle());
+            g_PostProcessMan.RegisterPostEffect(emitPos, m_pFlash->GetScreenEffect(), m_pFlash->GetScreenEffectHash(), 55 + 200 * PosRand(), m_pFlash->GetEffectRotAngle());
 //            g_SceneMan.RegisterPostEffect(emitPos, m_pFlash->GetScreenEffect(), 55 + (200 * PosRand() * ((float)1 - ((float)m_AgeTimer.GetElapsedSimTimeMS() / (float)m_Lifetime))));
     }
 }

Entities/AHuman.cpp

@@ -4534,7 +4534,7 @@ void AHuman::DrawThrowingReticule(BITMAP *pTargetBitmap, const Vector &targetPos
             points[i] += m_pFGArm->GetParentOffset();
 
         // Put the flickering glows on the reticule dots, in absolute scene coordinates
-        g_SceneMan.RegisterGlowDotEffect(points[i], YellowDot, 55 + 100 * PosRand());
+		g_PostProcessMan.RegisterGlowDotEffect(points[i], YellowDot, 55 + 100 * PosRand());
 
         putpixel(pTargetBitmap, points[i].m_X - targetPos.m_X, points[i].m_Y - targetPos.m_Y, g_YellowGlowColor);
     }

Entities/Actor.cpp

@@ -28,6 +28,7 @@
 #include "MOPixel.h"
 #include "Scene.h"
 #include "SettingsMan.h"
+#include "PerformanceMan.h"
 
 #include "GUI/GUI.h"
 #include "GUI/GUIFont.h"
@@ -1291,9 +1292,9 @@ bool Actor::UpdateAIScripted() {
 
     int status = !g_LuaMan.ExpressionIsTrue(m_ScriptPresetName, false) ? ReloadScripts() : 0;
     status = (status >= 0 && !ObjectScriptsInitialized()) ? InitializeObjectScripts() : status;
-    g_FrameMan.StartPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);
+    g_PerformanceMan.StartPerformanceMeasurement(PerformanceMan::PERF_ACTORS_AI);
     status = (status >= 0) ? RunScriptedFunctionInAppropriateScripts("UpdateAI", false, true) : status;
-    g_FrameMan.StopPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);
+    g_PerformanceMan.StopPerformanceMeasurement(PerformanceMan::PERF_ACTORS_AI);
 
     return status >= 0;
 }
@@ -1951,7 +1952,7 @@ void Actor::DrawHUD(BITMAP *pTargetBitmap, const Vector &targetPos, int whichScr
                 waypoint = (*vItr).first - targetPos;
                 circlefill(pTargetBitmap, waypoint.m_X, waypoint.m_Y, 2, g_YellowGlowColor);
                 // Add pixel glow area around it, in scene coordinates
-                g_SceneMan.RegisterGlowArea((*vItr).first, 5);
+				g_PostProcessMan.RegisterGlowArea((*vItr).first, 5);
             }
 
             // Draw line from the last movetarget on the current path to the first waypoint in queue after that
@@ -1979,7 +1980,7 @@ void Actor::DrawHUD(BITMAP *pTargetBitmap, const Vector &targetPos, int whichScr
             waypoint = m_MovePath.back() - targetPos;
             circlefill(pTargetBitmap, waypoint.m_X, waypoint.m_Y, 2, g_YellowGlowColor);
             // Add pixel glow area around it, in scene coordinates
-            g_SceneMan.RegisterGlowArea(m_MovePath.back(), 5);
+			g_PostProcessMan.RegisterGlowArea(m_MovePath.back(), 5);
         }
         // If no points left on movepath, then draw straight line to the movetarget
         else
@@ -1990,7 +1991,7 @@ void Actor::DrawHUD(BITMAP *pTargetBitmap, const Vector &targetPos, int whichScr
             waypoint = m_MoveTarget - targetPos;
             circlefill(pTargetBitmap, waypoint.m_X, waypoint.m_Y, 2, g_YellowGlowColor);
             // Add pixel glow area around it, in scene coordinates
-            g_SceneMan.RegisterGlowArea(m_MoveTarget, 5);
+			g_PostProcessMan.RegisterGlowArea(m_MoveTarget, 5);
         }
     }
 

Entities/Arm.cpp

@@ -518,17 +518,7 @@ void Arm::Update()
             else
             {
                 Vector handTarget = g_SceneMan.ShortestDistance(m_JointPos, m_TargetPoint);
-    /*
-                if (m_PresetName == "Player BG Arm") {
-                    char str[64];
-                    sprintf_s(str, sizeof(str), "TargetOffset: %f, %f", m_TargetPoint.m_X, m_TargetPoint.m_Y);
-                    g_FrameMan.DrawText(g_SceneMan.GetMOBitmap(), str, m_Pos + Vector(4, -140), false);
-                    sprintf_s(str, sizeof(str), "m_Pos: %f, %f", m_Pos.m_X, m_Pos.m_Y);
-                    g_FrameMan.DrawText(g_SceneMan.GetMOBitmap(), str, m_Pos + Vector(4, -120), false);
-                    sprintf_s(str, sizeof(str), "handTarget: %f, %f", handTarget.m_X, handTarget.m_Y);
-                    g_FrameMan.DrawText(g_SceneMan.GetMOBitmap(), str, m_Pos + Vector(4, -100), false);
-                }
-    */
+
                 // Check if handTarget is within arm's length.
     // TEMP the +3 is a hack! improve
                 if (handTarget.GetMagnitude() <= m_MaxLength || !m_WillIdle/* && handTarget.GetFloored() != m_HandOffset.GetFloored()*/)
@@ -647,15 +637,6 @@ void Arm::Draw(BITMAP *pTargetBitmap,
 
     if (m_pHeldMO && ((!m_pHeldMO->IsHeldDevice() && !m_pHeldMO->IsThrownDevice()) || m_pHeldMO->IsDrawnAfterParent()))
         m_pHeldMO->Draw(pTargetBitmap, targetPos, mode, onlyPhysical);
-/*
-#ifdef DEBUG_BUILD
-    if (m_PresetName == "Player BG Arm") {
-        char str[64];
-        sprintf_s(str, sizeof(str), "m_Pos in draw: %f, %f", m_Pos.m_X, m_Pos.m_Y);
-        g_FrameMan.DrawText(pTargetBitmap, str, m_Pos + Vector(4, -80), false);
-    }
-#endif
-*/
 }
 
 
@@ -680,15 +661,6 @@ void Arm::DrawHand(BITMAP *pTargetBitmap,
         draw_sprite(pTargetBitmap, m_pHand, handPos.m_X, handPos.m_Y);
     else
         draw_sprite_h_flip(pTargetBitmap, m_pHand, handPos.m_X, handPos.m_Y);
-/*
-#ifdef DEBUG_BUILD
-    if (m_PresetName == "Player BG Arm") {
-        char str[64];
-        sprintf_s(str, sizeof(str), "HandPos in hand draw: %f, %f", handPos.m_X, handPos.m_Y);
-        g_FrameMan.DrawText(pTargetBitmap, str, handPos + Vector(4, -40), false);
-    }
-#endif
-*/
 }
 
 } // namespace RTE