Added showfps command.

Author: DavidF-Dev

Runtime/DevConsoleMono.cs

@@ -50,6 +50,7 @@ internal sealed class DevConsoleMono : MonoBehaviour
         private const float MaxConsoleHeight = 900;
         private const int CommandHistoryLength = 10;
         private const int MaxCachedEnumTypes = 6;
+        private const float FpsUpdateRate = 4f;
 
         #region Input constants
 
@@ -88,6 +89,7 @@ internal sealed class DevConsoleMono : MonoBehaviour
         private const string PrefDisplayUnityErrors = "DevConsole.displayUnityErrors";
         private const string PrefDisplayUnityExceptions = "DevConsole.displayUnityExceptions";
         private const string PrefDisplayUnityWarnings = "DevConsole.displayUnityWarnings";
+        private const string PrefShowFps = "DevConsole.displayFps";
 
         #endregion
 
@@ -173,6 +175,19 @@ internal sealed class DevConsoleMono : MonoBehaviour
 
         #endregion
 
+        #region Fps fields
+
+        private bool _isDisplayingFps;
+        private float _fpsDeltaTime;
+        private int _fps;
+        private float _fpsMs;
+        private float _fpsElapsed;
+        private GUIStyle _fpsStyle;
+        private Vector2 _fpsLabelSize;
+        private Color _fpsTextColour;
+
+        #endregion
+
         #endregion
 
         #region Properties
@@ -624,6 +639,7 @@ private void Awake()
 
             LoadPreferences();
             InitBuiltInCommands();
+            InitBuiltInParsers();
             InitAttributeCommands();
 
             // Enable the console by default if in editor or a development build
@@ -693,6 +709,35 @@ private void LateUpdate()
                 return;
             }
 
+            // Update fps display
+            if (_isDisplayingFps)
+            {
+                _fpsDeltaTime += (Time.unscaledDeltaTime - _fpsDeltaTime) * 0.1f;
+                _fpsElapsed += Time.deltaTime;
+                if (_fpsElapsed > 1.0f / FpsUpdateRate)
+                {
+                    // Calculate fps values
+                    _fpsMs = _fpsDeltaTime * 1000f;
+                    _fps = Mathf.RoundToInt(1.0f / _fpsDeltaTime);
+                    _fpsElapsed -= 1.0f / FpsUpdateRate;
+
+                    // Determine colour
+                    _fpsTextColour = Color.white;
+                    if (Application.targetFrameRate == -1 && _fps >= 60 || Application.targetFrameRate != -1 && _fps >= Application.targetFrameRate)
+                    {
+                        _fpsTextColour = Color.green;
+                    }
+                    else if (_fps < 10)
+                    {
+                        _fpsTextColour = Color.red;
+                    }
+                    else if (_fps < 30 && (Application.targetFrameRate > 30 || Application.targetFrameRate == -1))
+                    {
+                        _fpsTextColour = Color.yellow;
+                    }
+                }
+            }
+
             // Check bindings (as long as the input field isn't focused!)
             if (BindingsIsEnabled && !_inputField.isFocused)
             {
@@ -766,6 +811,46 @@ private void LateUpdate()
             }
         }
 
+        private void OnGUI()
+        {
+            if (!ConsoleIsEnabled)
+            {
+                return;
+            }
+
+            if (_isDisplayingFps)
+            {
+                if (_fpsStyle == null)
+                {
+                    // Create the style
+                    _fpsStyle = new GUIStyle(GUI.skin.box)
+                    {
+                        alignment = TextAnchor.MiddleCenter,
+                        fontSize = 20,
+                        normal = { textColor = Color.white, background = Texture2D.whiteTexture }
+                    };
+
+                    _fpsLabelSize = _fpsStyle.CalcSize(new GUIContent("0.00 ms (000 fps)"));
+                }
+
+                Color oldBackgroundColour = GUI.backgroundColor;
+                Color oldContentColour = GUI.contentColor;
+
+                // Set colours
+                GUI.backgroundColor = new Color(0f, 0f, 0f, 0.75f);
+                GUI.contentColor = _fpsTextColour;
+
+                // Create label
+                GUI.Box(
+                    new Rect(10, 10, _fpsLabelSize.x + 10f, _fpsLabelSize.y + 10f),
+                    $"{_fpsMs:0.00} ms ({_fps:0.} fps)",
+                    _fpsStyle);
+
+                GUI.backgroundColor = oldBackgroundColour;
+                GUI.contentColor = oldContentColour;
+            }
+        }
+
         private void OnDestroy()
         {
             SavePreferences();
@@ -1078,6 +1163,32 @@ private void InitBuiltInCommands()
                 () => LogVariable("Application path", AppDomain.CurrentDomain.BaseDirectory)
             ));
 
+            AddCommand(Command.Create<bool>(
+                "showfps",
+                "displayfps",
+                "Query or set whether the fps is being displayed on-screen",
+                Parameter.Create("enabled", "Whether the fps is being displayed on-screen"),
+                b =>
+                {
+                    if (b != _isDisplayingFps)
+                    {
+                        _isDisplayingFps = !_isDisplayingFps;
+
+                        if (_isDisplayingFps)
+                        {
+                            _fps = 0;
+                            _fpsMs = 0f;
+                            _fpsDeltaTime = 0f;
+                            _fpsElapsed = 0f;
+                            _fpsStyle = null;
+                        }
+                    }
+
+                    LogSuccess($"{(b ? "Enabled" : "Disabled")} the on-screen fps.");
+                },
+                () => LogVariable("Show fps", _isDisplayingFps)
+                ));
+
             #endregion
 
             #region Screen commands
@@ -1142,8 +1253,8 @@ private void InitBuiltInCommands()
             ));
 
             AddCommand(Command.Create<int>(
-                "fps_target",
-                "fps_max",
+                "targetfps",
+                "",
                 "Query or set the target frame rate.",
                 Parameter.Create("targetFrameRate", "Frame rate the application will try to render at."),
                 i =>
@@ -1520,6 +1631,11 @@ void logChildren(GameObject obj, int tabAmount)
             #endregion
         }
 
+        private void InitBuiltInParsers()
+        {
+
+        }
+
         private void InitAttributeCommands()
         {
             // https://github.com/yasirkula/UnityIngameDebugConsole/blob/master/Plugins/IngameDebugConsole/Scripts/DebugLogConsole.cs
@@ -2000,6 +2116,7 @@ private void SavePreferences()
             DevConsoleData.SetObject(PrefDisplayUnityErrors, _displayUnityErrors);
             DevConsoleData.SetObject(PrefDisplayUnityExceptions, _displayUnityExceptions);
             DevConsoleData.SetObject(PrefDisplayUnityWarnings, _displayUnityWarnings);
+            DevConsoleData.SetObject(PrefShowFps, _isDisplayingFps);
 
             DevConsoleData.Save();
         }
@@ -2014,6 +2131,7 @@ private void LoadPreferences()
             _displayUnityErrors = DevConsoleData.GetObject(PrefDisplayUnityErrors, true);
             _displayUnityExceptions = DevConsoleData.GetObject(PrefDisplayUnityExceptions, true);
             _displayUnityWarnings = DevConsoleData.GetObject(PrefDisplayUnityWarnings, true);
+            _isDisplayingFps = DevConsoleData.GetObject(PrefShowFps, false);
 
             DevConsoleData.Clear();
         }