Srp workflows - Debug panel system to core

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

@@ -10,6 +10,7 @@ Version Updated
 The version number for this package has increased due to a version update of a related graphics package.
 
 ### Added
+- Debug Panels Framework See `IDebugDisplaySettingsQuery`.
 - New `IVolumeDebugSettings` interface and `VolumeDebugSettings<T>` class that stores the information for the Volumes Debug Panel.
 - Added AMD FidelityFX shaders which were originally in HDRP
 

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

@@ -0,0 +1,108 @@
+using System;
+using System.Collections.Generic;
+
+namespace UnityEngine.Rendering
+{
+    /// <summary>
+    /// Templated class for <see cref="IDebugDisplaySettings"/>
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    public abstract class DebugDisplaySettings<T> : IDebugDisplaySettings
+        where T : IDebugDisplaySettings, new()
+    {
+        protected readonly HashSet<IDebugDisplaySettingsData> m_Settings = new HashSet<IDebugDisplaySettingsData>();
+
+        private static readonly Lazy<T> s_Instance = new Lazy<T>(() =>
+        {
+            var instance = new T();
+            instance.Reset();
+            return instance;
+        });
+
+        /// <summary>
+        /// The singleton instance that contains the current settings of Rendering Debugger.
+        /// </summary>
+        public static T Instance => s_Instance.Value;
+
+        #region IDebugDisplaySettingsQuery
+
+        /// <summary>
+        /// Returns true if any of the debug settings are currently active.
+        /// </summary>
+        public virtual bool AreAnySettingsActive
+        {
+            get
+            {
+                foreach (IDebugDisplaySettingsData setting in m_Settings)
+                {
+                    if (setting.AreAnySettingsActive)
+                        return true;
+                }
+
+                return false;
+            }
+        }
+
+        /// <summary>
+        /// Checks whether the current state of these settings allows post-processing.
+        /// </summary>
+        public virtual bool IsPostProcessingAllowed { get; }
+
+        /// <summary>
+        /// Returns true if lighting is active for current state of debug settings.
+        /// </summary>
+        public virtual bool IsLightingActive
+        {
+            get
+            {
+                bool lightingActive = true;
+                foreach (IDebugDisplaySettingsData setting in m_Settings)
+                    lightingActive &= setting.IsLightingActive;
+                return lightingActive;
+            }
+        }
+        #endregion
+
+        protected TData Add<TData>(TData newData) where TData : IDebugDisplaySettingsData
+        {
+            m_Settings.Add(newData);
+            return newData;
+        }
+
+        /// <summary>
+        /// Executes an action for each element
+        /// </summary>
+        /// <param name="onExecute"></param>
+        public void ForEach(Action<IDebugDisplaySettingsData> onExecute)
+        {
+            foreach (IDebugDisplaySettingsData setting in m_Settings)
+            {
+                onExecute(setting);
+            }
+        }
+
+        /// <summary>
+        /// Reset the stored debug settings
+        /// </summary>
+        public virtual void Reset()
+        {
+            m_Settings.Clear();
+        }
+
+        /// <summary>
+        /// Attempts to get the color that should be used to clear the screen according to current debug settings.
+        /// </summary>
+        /// <param name="color">A reference to the screen clear color to use.</param>
+        /// <returns>True if the color reference was updated, and false otherwise.</returns>
+        public virtual bool TryGetScreenClearColor(ref Color color)
+        {
+            foreach (IDebugDisplaySettingsData setting in m_Settings)
+            {
+                if (setting.TryGetScreenClearColor(ref color))
+                    return true;
+            }
+
+            return false;
+        }
+    }
+}

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

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-namespace UnityEngine.Rendering.Universal
+namespace UnityEngine.Rendering
 {
     public abstract class DebugDisplaySettingsPanel : IDebugDisplaySettingsPanelDisposable
     {
@@ -14,9 +14,14 @@ protected void AddWidget(DebugUI.Widget widget)
             m_Widgets.Add(widget);
         }
 
-        public void Dispose()
+        protected void Clear()
         {
             m_Widgets.Clear();
         }
+
+        public void Dispose()
+        {
+            Clear();
+        }
     }
 }

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

@@ -1,12 +1,12 @@
 using System;
 using System.Collections.Generic;
 
-namespace UnityEngine.Rendering.Universal
+namespace UnityEngine.Rendering
 {
     public class DebugDisplaySettingsUI : IDebugData
     {
         private IEnumerable<IDebugDisplaySettingsPanelDisposable> m_DisposablePanels;
-        private DebugDisplaySettings m_Settings;
+        private IDebugDisplaySettings m_Settings;
 
         private void Reset()
         {
@@ -21,7 +21,7 @@ private void Reset()
             }
         }
 
-        public void RegisterDebug(DebugDisplaySettings settings)
+        public void RegisterDebug(IDebugDisplaySettings settings)
         {
             DebugManager debugManager = DebugManager.instance;
             List<IDebugDisplaySettingsPanelDisposable> panels = new List<IDebugDisplaySettingsPanelDisposable>();

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

@@ -0,0 +1,22 @@
+using System;
+using UnityEngine;
+
+namespace UnityEngine.Rendering
+{
+    /// <summary>
+    /// Interface for storing the debug settings
+    /// </summary>
+    public interface IDebugDisplaySettings : IDebugDisplaySettingsQuery
+    {
+        /// <summary>
+        /// Reset the stored debug settings
+        /// </summary>
+        void Reset();
+
+        /// <summary>
+        /// Executes an action for each element
+        /// </summary>
+        /// <param name="onExecute"></param>
+        void ForEach(Action<IDebugDisplaySettingsData> onExecute);
+    }
+}

com.unity.render-pipelines.universal/Runtime/Debug/IDebugDisplaySettingsData.cs → com.unity.render-pipelines.core/Runtime/Debugging/IDebugDisplaySettingsData.cs

@@ -1,5 +1,8 @@
-namespace UnityEngine.Rendering.Universal
+namespace UnityEngine.Rendering
 {
+    /// <summary>
+    /// Debug UI panel interface
+    /// </summary>
     public interface IDebugDisplaySettingsData : IDebugDisplaySettingsQuery
     {
         /// <summary>

com.unity.render-pipelines.universal/Runtime/Debug/IDebugDisplaySettingsPanel.cs → com.unity.render-pipelines.core/Runtime/Debugging/IDebugDisplaySettingsPanel.cs

@@ -1,7 +1,10 @@
 using System;
 
-namespace UnityEngine.Rendering.Universal
+namespace UnityEngine.Rendering
 {
+    /// <summary>
+    /// Debug UI panel
+    /// </summary>
     public interface IDebugDisplaySettingsPanel
     {
         /// <summary>
@@ -15,6 +18,9 @@ public interface IDebugDisplaySettingsPanel
         DebugUI.Widget[] Widgets { get; }
     }
 
+    /// <summary>
+    /// Debug UI panel disposable
+    /// </summary>
     public interface IDebugDisplaySettingsPanelDisposable : IDebugDisplaySettingsPanel, IDisposable
     {
     }

com.unity.render-pipelines.universal/Runtime/Debug/IDebugDisplaySettingsQuery.cs → com.unity.render-pipelines.core/Runtime/Debugging/IDebugDisplaySettingsQuery.cs

@@ -1,6 +1,6 @@
 using UnityEngine;
 
-namespace UnityEngine.Rendering.Universal
+namespace UnityEngine.Rendering
 {
     /// <summary>
     /// Interface for determining what kind of debug settings are currently active.

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsCommon.cs

@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using UnityEngine;
 
 namespace UnityEngine.Rendering.Universal
 {
@@ -32,9 +31,10 @@ private class SettingsPanel : DebugDisplaySettingsPanel
 
             public SettingsPanel()
             {
-                AddWidget(DebugDisplaySettingsCommon.WidgetFactory.CreateMissingDebugShadersWarning());
+                AddWidget(WidgetFactory.CreateMissingDebugShadersWarning());
 
-                var materialSettingsData = DebugDisplaySettings.Instance.MaterialSettings;
+                var debugDisplaySettings = UniversalRenderPipelineDebugDisplaySettings.Instance;
+                var materialSettingsData = debugDisplaySettings.MaterialSettings;
                 AddWidget(new DebugUI.Foldout
                 {
                     displayName = "Material Filters",
@@ -54,7 +54,7 @@ public SettingsPanel()
                     }
                 });
 
-                var lightingSettingsData = DebugDisplaySettings.Instance.LightingSettings;
+                var lightingSettingsData = debugDisplaySettings.LightingSettings;
                 AddWidget(new DebugUI.Foldout
                 {
                     displayName = "Lighting Debug Modes",
@@ -75,7 +75,7 @@ public SettingsPanel()
                     }
                 });
 
-                var renderingSettingsData = DebugDisplaySettings.Instance.RenderingSettings;
+                var renderingSettingsData = debugDisplaySettings.RenderingSettings;
                 AddWidget(new DebugUI.Foldout
                 {
                     displayName = "Rendering Debug",
@@ -103,11 +103,11 @@ public SettingsPanel()
         }
 
         #region IDebugDisplaySettingsData
-
-        public bool AreAnySettingsActive => DebugDisplaySettings.Instance.AreAnySettingsActive;
-        public bool IsPostProcessingAllowed => DebugDisplaySettings.Instance.IsPostProcessingAllowed;
-        public bool IsLightingActive => DebugDisplaySettings.Instance.IsLightingActive;
-        public bool TryGetScreenClearColor(ref Color color) => DebugDisplaySettings.Instance.TryGetScreenClearColor(ref color);
+        UniversalRenderPipelineDebugDisplaySettings debugDisplaySettings => UniversalRenderPipelineDebugDisplaySettings.Instance;
+        public bool AreAnySettingsActive => debugDisplaySettings.AreAnySettingsActive;
+        public bool IsPostProcessingAllowed => debugDisplaySettings.IsPostProcessingAllowed;
+        public bool IsLightingActive => debugDisplaySettings.IsLightingActive;
+        public bool TryGetScreenClearColor(ref Color color) => debugDisplaySettings.TryGetScreenClearColor(ref color);
 
         public IDebugDisplaySettingsPanelDisposable CreatePanel()
         {

com.unity.render-pipelines.universal/Runtime/Debug/DebugHandler.cs

@@ -55,7 +55,7 @@ class DebugHandler : IDebugDisplaySettingsQuery
         Vector4 m_DebugRenderTargetPixelRect;
         RenderTargetIdentifier m_DebugRenderTargetIdentifier;
 
-        readonly DebugDisplaySettings m_DebugDisplaySettings;
+        readonly UniversalRenderPipelineDebugDisplaySettings m_DebugDisplaySettings;
 
         DebugDisplaySettingsLighting LightingSettings => m_DebugDisplaySettings.LightingSettings;
         DebugDisplaySettingsMaterial MaterialSettings => m_DebugDisplaySettings.MaterialSettings;
@@ -84,7 +84,7 @@ public bool TryGetScreenClearColor(ref Color color)
         #endregion
 
         internal Material ReplacementMaterial => m_ReplacementMaterial;
-        internal DebugDisplaySettings DebugDisplaySettings => m_DebugDisplaySettings;
+        internal UniversalRenderPipelineDebugDisplaySettings DebugDisplaySettings => m_DebugDisplaySettings;
 
         internal bool IsScreenClearNeeded
         {
@@ -108,7 +108,7 @@ internal DebugHandler(ScriptableRendererData scriptableRendererData)
         {
             Shader debugReplacementShader = scriptableRendererData.debugShaders.debugReplacementPS;
 
-            m_DebugDisplaySettings = DebugDisplaySettings.Instance;
+            m_DebugDisplaySettings = UniversalRenderPipelineDebugDisplaySettings.Instance;
 
             m_ReplacementMaterial = (debugReplacementShader == null) ? null : CoreUtils.CreateEngineMaterial(debugReplacementShader);
         }