Realtime profiler (HDRP & URP)

TestProjects/HDRP_Tests/ProjectSettings/ProjectSettings.asset

@@ -153,7 +153,7 @@ PlayerSettings:
     enable360StereoCapture: 0
   isWsaHolographicRemotingEnabled: 0
   protectGraphicsMemory: 0
-  enableFrameTimingStats: 0
+  enableFrameTimingStats: 1
   useHDRDisplay: 0
   m_ColorGamuts: 00000000
   targetPixelDensity: 30

com.unity.render-pipelines.core/CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 - Added support for high performant unsafe (uint only) Radix, Merge and Insertion sort algorithms on CoreUnsafeUtils.
+- Added DebugFrameTiming class that can be used by render pipelines to display CPU/GPU frame timings and bottlenecks in Rendering Debugger.
+- Added new DebugUI widget types: ProgressBarValue and ValueTuple
 
 ## [13.1.0] - 2021-09-24
 

com.unity.render-pipelines.core/Editor/Debugging/DebugUIDrawer.Builtins.cs

@@ -21,7 +21,70 @@ public override bool OnGUI(DebugUI.Widget widget, DebugState state)
         {
             var w = Cast<DebugUI.Value>(widget);
             var rect = PrepareControlRect();
-            EditorGUI.LabelField(rect, EditorGUIUtility.TrTextContent(w.displayName), EditorGUIUtility.TrTextContent(w.GetValue().ToString()));
+            var value = w.GetValue();
+            EditorGUI.LabelField(rect, EditorGUIUtility.TrTextContent(w.displayName), EditorGUIUtility.TrTextContent(w.FormatString(value)));
+            return true;
+        }
+    }
+
+    /// <summary>
+    /// Builtin Drawer for ValueTuple Debug Items.
+    /// </summary>
+    [DebugUIDrawer(typeof(DebugUI.ValueTuple))]
+    public sealed class DebugUIDrawerValueTuple : DebugUIDrawer
+    {
+        /// <summary>
+        /// OnGUI implementation for ValueTuple DebugUIDrawer.
+        /// </summary>
+        /// <param name="widget">DebugUI Widget.</param>
+        /// <param name="state">Debug State associated with the Debug Item.</param>
+        /// <returns>The state of the widget.</returns>
+        public override bool OnGUI(DebugUI.Widget widget, DebugState state)
+        {
+            var w = Cast<DebugUI.ValueTuple>(widget);
+
+            var labelRect = PrepareControlRect();
+            EditorGUI.PrefixLabel(labelRect, EditorGUIUtility.TrTextContent(w.displayName));
+
+            // Following layout should match DebugUIDrawerFoldout to make column labels align
+            Rect drawRect = GUILayoutUtility.GetLastRect();
+            int indent = EditorGUI.indentLevel;
+            EditorGUI.indentLevel = 0; //be at left of rects
+            for (int i = 0; i < w.numElements; i++)
+            {
+                var columnRect = drawRect;
+                columnRect.x += EditorGUIUtility.labelWidth + i * DebugWindow.Styles.foldoutColumnWidth;
+                columnRect.width = DebugWindow.Styles.foldoutColumnWidth;
+                var value = w.values[i].GetValue();
+                EditorGUI.LabelField(columnRect, w.values[i].FormatString(value));
+            }
+            EditorGUI.indentLevel = indent;
+
+            return true;
+        }
+    }
+
+    /// <summary>
+    /// Builtin Drawer for ProgressBarValue Debug Items.
+    /// </summary>
+    [DebugUIDrawer(typeof(DebugUI.ProgressBarValue))]
+    public sealed class DebugUIDrawerProgressBarValue : DebugUIDrawer
+    {
+        /// <summary>
+        /// OnGUI implementation for Value DebugUIDrawer.
+        /// </summary>
+        /// <param name="widget">DebugUI Widget.</param>
+        /// <param name="state">Debug State associated with the Debug Item.</param>
+        /// <returns>The state of the widget.</returns>
+        public override bool OnGUI(DebugUI.Widget widget, DebugState state)
+        {
+            var w = Cast<DebugUI.ProgressBarValue>(widget);
+
+            var labelRect = PrepareControlRect();
+            var progressBarRect = EditorGUI.PrefixLabel(labelRect, EditorGUIUtility.TrTextContent(w.displayName));
+            float value = (float)w.GetValue();
+            EditorGUI.ProgressBar(progressBarRect, value, w.FormatString(value));
+
             return true;
         }
     }
@@ -435,14 +498,13 @@ public override void Begin(DebugUI.Widget widget, DebugState state)
             Rect drawRect = GUILayoutUtility.GetLastRect();
             if (w.columnLabels != null && value)
             {
-                const int oneColumnWidth = 70;
                 int indent = EditorGUI.indentLevel;
                 EditorGUI.indentLevel = 0; //be at left of rects
                 for (int i = 0; i < w.columnLabels.Length; i++)
                 {
                     var columnRect = drawRect;
-                    columnRect.x += EditorGUIUtility.labelWidth + i * oneColumnWidth;
-                    columnRect.width = oneColumnWidth;
+                    columnRect.x += EditorGUIUtility.labelWidth + i * DebugWindow.Styles.foldoutColumnWidth;
+                    columnRect.width = DebugWindow.Styles.foldoutColumnWidth;
                     string label = w.columnLabels[i] ?? "";
                     string tooltip = w.columnTooltips?.ElementAtOrDefault(i) ?? "";
                     EditorGUI.LabelField(columnRect, EditorGUIUtility.TrTextContent(label, tooltip), EditorStyles.miniBoldLabel);
@@ -461,8 +523,8 @@ public override void Begin(DebugUI.Widget widget, DebugState state)
         /// <returns>The state of the widget.</returns>
         public override bool OnGUI(DebugUI.Widget widget, DebugState state)
         {
-            var s = Cast<DebugStateBool>(state);
-            return s.value;
+            var w = Cast<DebugUI.Foldout>(widget);
+            return w.opened;
         }
 
         /// <summary>

com.unity.render-pipelines.core/Editor/Debugging/DebugWindow.cs

@@ -130,11 +130,6 @@ static void Init()
         {
             var window = GetWindow<DebugWindow>();
             window.titleContent = Styles.windowTitle;
-
-            if (OnDebugWindowToggled == null)
-                OnDebugWindowToggled += DebugManager.instance.ToggleEditorUI;
-
-            open = true;
         }
 
         [MenuItem("Window/Analysis/Rendering Debugger", validate = true)]
@@ -145,6 +140,11 @@ static bool ValidateMenuItem()
 
         void OnEnable()
         {
+            if (OnDebugWindowToggled == null)
+                OnDebugWindowToggled += DebugManager.instance.ToggleEditorUI;
+
+            open = true;
+
             DebugManager.instance.refreshEditorRequested = false;
 
             hideFlags = HideFlags.HideAndDontSave;
@@ -564,6 +564,8 @@ public class Styles
             public readonly GUIStyle sectionHeader = new GUIStyle(EditorStyles.largeLabel);
             public readonly Color skinBackgroundColor;
 
+            public static int foldoutColumnWidth = 70;
+
             public Styles()
             {
                 Color textColorDarkSkin = new Color32(210, 210, 210, 255);

com.unity.render-pipelines.core/Runtime/AssemblyInfo.cs

@@ -5,3 +5,4 @@
 #endif
 
 [assembly: InternalsVisibleTo("Unity.RenderPipelines.Core.Editor")]
+[assembly: InternalsVisibleTo("Unity.RenderPipelines.Core.Runtime.Tests")]

com.unity.render-pipelines.core/Runtime/Debugging/DebugDisplaySettingsPanel.cs

@@ -8,6 +8,7 @@ public abstract class DebugDisplaySettingsPanel : IDebugDisplaySettingsPanelDisp
 
         public abstract string PanelName { get; }
         public DebugUI.Widget[] Widgets => m_Widgets.ToArray();
+        public virtual DebugUI.Flags Flags => DebugUI.Flags.None;
 
         protected void AddWidget(DebugUI.Widget widget)
         {

com.unity.render-pipelines.core/Runtime/Debugging/DebugDisplaySettingsUI.cs

@@ -39,6 +39,7 @@ public void RegisterDebug(IDebugDisplaySettings settings)
                 DebugUI.Panel panel = debugManager.GetPanel(panelId, true);
                 ObservableList<DebugUI.Widget> panelChildren = panel.children;
 
+                panel.flags = disposableSettingsPanel.Flags;
                 panels.Add(disposableSettingsPanel);
                 panelChildren.Add(panelWidgets);
             };

com.unity.render-pipelines.core/Runtime/Debugging/DebugFrameTiming.cs

@@ -0,0 +1,201 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using UnityEngine;
+
+//#define RTPROFILER_DEBUG
+
+namespace UnityEngine.Rendering
+{
+    public class DebugFrameTiming
+    {
+        const string k_FpsFormatString = "{0:F1}";
+        const string k_MsFormatString = "{0:F2}ms";
+        const float k_RefreshRate = 1f / 5f;
+
+        internal FrameTimeSampleHistory m_FrameHistory = new();
+        internal BottleneckHistory m_BottleneckHistory = new();
+
+        /// <summary>
+        /// Size of the Bottleneck History Window in number of samples.
+        /// </summary>
+        public int bottleneckHistorySize { get; set; } = 60;
+
+        /// <summary>
+        /// Size of the Sample History Window in number of samples.
+        /// </summary>
+        public int sampleHistorySize { get; set; } = 30;
+
+        FrameTiming[] m_Timing = new FrameTiming[1];
+        FrameTimeSample m_Sample = new FrameTimeSample();
+
+        /// <summary>
+        /// Update timing data from profiling counters.
+        /// </summary>
+        public void UpdateFrameTiming()
+        {
+            m_Timing[0] = default;
+            m_Sample = default;
+            FrameTimingManager.CaptureFrameTimings();
+            FrameTimingManager.GetLatestTimings(1, m_Timing);
+
+            if (m_Timing.Length > 0)
+            {
+                m_Sample.FullFrameTime = (float)m_Timing.First().cpuFrameTime;
+                m_Sample.FramesPerSecond = m_Sample.FullFrameTime > 0f ? 1000f / m_Sample.FullFrameTime : 0f;
+                m_Sample.MainThreadCPUFrameTime = (float)m_Timing.First().cpuMainThreadFrameTime;
+                m_Sample.MainThreadCPUPresentWaitTime = (float)m_Timing.First().cpuMainThreadPresentWaitTime;
+                m_Sample.RenderThreadCPUFrameTime = (float)m_Timing.First().cpuRenderThreadFrameTime;
+                m_Sample.GPUFrameTime = (float)m_Timing.First().gpuFrameTime;
+            }
+
+            m_FrameHistory.DiscardOldSamples(sampleHistorySize);
+            m_FrameHistory.Add(m_Sample);
+            m_FrameHistory.ComputeAggregateValues();
+
+            m_BottleneckHistory.DiscardOldSamples(bottleneckHistorySize);
+            m_BottleneckHistory.AddBottleneckFromAveragedSample(m_FrameHistory.SampleAverage);
+            m_BottleneckHistory.ComputeHistogram();
+        }
+
+        /// <summary>
+        /// Add frame timing data widgets to debug UI.
+        /// </summary>
+        /// <param name="list">List of widgets to add the stats.</param>
+        public void RegisterDebugUI(List<DebugUI.Widget> list)
+        {
+            list.Add(new DebugUI.Foldout()
+            {
+                displayName = "Frame Stats",
+                opened = true,
+                columnLabels = new string[] { "Avg", "Min", "Max" },
+                children =
+                {
+                    new DebugUI.ValueTuple
+                    {
+                        displayName = "Frame Rate (FPS)",
+                        values = new[]
+                        {
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_FpsFormatString, getter = () => m_FrameHistory.SampleAverage.FramesPerSecond },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_FpsFormatString, getter = () => m_FrameHistory.SampleMin.FramesPerSecond },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_FpsFormatString, getter = () => m_FrameHistory.SampleMax.FramesPerSecond },
+                        }
+                    },
+                    new DebugUI.ValueTuple
+                    {
+                        displayName = "Frame Time",
+                        values = new[]
+                        {
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleAverage.FullFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMin.FullFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMax.FullFrameTime },
+                        }
+                    },
+                    new DebugUI.ValueTuple
+                    {
+                        displayName = "CPU Main Thread Frame",
+                        values = new[]
+                        {
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleAverage.MainThreadCPUFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMin.MainThreadCPUFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMax.MainThreadCPUFrameTime },
+                        }
+                    },
+                    new DebugUI.ValueTuple
+                    {
+                        displayName = "CPU Render Thread Frame",
+                        values = new[]
+                        {
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleAverage.RenderThreadCPUFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMin.RenderThreadCPUFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMax.RenderThreadCPUFrameTime },
+                        }
+                    },
+                    new DebugUI.ValueTuple
+                    {
+                        displayName = "CPU Present Wait",
+                        values = new[]
+                        {
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleAverage.MainThreadCPUPresentWaitTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMin.MainThreadCPUPresentWaitTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMax.MainThreadCPUPresentWaitTime },
+                        }
+                    },
+                    new DebugUI.ValueTuple
+                    {
+                        displayName = "GPU Frame",
+                        values = new[]
+                        {
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleAverage.GPUFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMin.GPUFrameTime },
+                            new DebugUI.Value { refreshRate = k_RefreshRate, formatString = k_MsFormatString, getter = () => m_FrameHistory.SampleMax.GPUFrameTime },
+                        }
+                    }
+                }
+            });
+
+            list.Add(new DebugUI.Foldout
+            {
+                displayName = "Bottlenecks",
+                children =
+                {
+#if UNITY_EDITOR
+                    new DebugUI.Container { displayName = "Not supported in Editor" }
+#else
+                    new DebugUI.ProgressBarValue { displayName = "CPU", getter = () => m_BottleneckHistory.Histogram.CPU },
+                    new DebugUI.ProgressBarValue { displayName = "GPU", getter = () => m_BottleneckHistory.Histogram.GPU },
+                    new DebugUI.ProgressBarValue { displayName = "Present limited", getter = () => m_BottleneckHistory.Histogram.PresentLimited },
+                    new DebugUI.ProgressBarValue { displayName = "Balanced", getter = () => m_BottleneckHistory.Histogram.Balanced },
+#endif
+                }
+            });
+#if RTPROFILER_DEBUG
+            list.Add(new DebugUI.Foldout
+            {
+                displayName = "Realtime Profiler Debug",
+                children =
+                {
+                    new DebugUI.IntField
+                    {
+                        displayName = "Frame Time Sample History Size",
+                        getter = () => SampleHistorySize,
+                        setter = (value) => { SampleHistorySize = value; },
+                        min = () => 1,
+                        max = () => 100
+                    },
+                    new DebugUI.IntField
+                    {
+                        displayName = "Bottleneck History Size",
+                        getter = () => BottleneckHistorySize,
+                        setter = (value) => { BottleneckHistorySize = value; },
+                        min = () => 1,
+                        max = () => 100
+                    },
+                    new DebugUI.IntField
+                    {
+                        displayName = "Force VSyncCount",
+                        min = () => - 1,
+                        max = () => 4,
+                        getter = () => QualitySettings.vSyncCount,
+                        setter = (value) => { QualitySettings.vSyncCount = value; }
+                    },
+                    new DebugUI.IntField
+                    {
+                        displayName = "Force TargetFrameRate",
+                        min = () => - 1,
+                        max = () => 1000,
+                        getter = () => Application.targetFrameRate,
+                        setter = (value) => { Application.targetFrameRate = value; }
+                    },
+                }
+            });
+#endif
+        }
+
+        internal void Reset()
+        {
+            m_BottleneckHistory.Clear();
+            m_FrameHistory.Clear();
+        }
+    }
+}