Merge pull request #476 from Unity-Technologies/shader-stripping

Shader stripping (should fix #467, #474 and #476)

Author: Chman

PostProcessing/Editor/PostProcessResourceStripper.cs

@@ -1,19 +1,18 @@
+using System;
 using UnityEditor.Build;
 using UnityEngine;
-using UnityEngine.SceneManagement;
 using UnityEngine.Rendering.PostProcessing;
 
 namespace UnityEditor.Rendering.PostProcessing
 {
     public sealed class PostProcessResourceStripper : ScriptableObject
     {
-        public const string DefaultStrippingConfigAssetPath = "Assets/PostProcessStrippingConfig.asset";
-
-        PostProcessStrippingConfig stripping;
-        PostProcessStrippingConfig defaultConfig;
+        [SerializeField] private PostProcessResources resources;
+        [SerializeField] private PostProcessResources unstrippedResources;
+        [SerializeField] private PostProcessStrippingConfig stripping;
 
-        [SerializeField]
-        PostProcessResources unstrippedResources;
+        public const string DefaultStrippingConfigAssetPath = "Assets/PostProcessStrippingConfig.asset";
+        bool enabled = true;
 
         static PostProcessResourceStripper s_Instance;
 
@@ -24,52 +23,14 @@ public static PostProcessResourceStripper instance
                 if (s_Instance == null)
                 {
                     s_Instance = CreateInstance<PostProcessResourceStripper>();
-                    s_Instance.defaultConfig = CreateInstance<PostProcessStrippingConfig>();
+                    s_Instance.unstrippedResources.changeHandler = Update;
                 }
 
                 return s_Instance;
             }
         }
 
-        void Awake()
-        {
-            SceneManager.sceneLoaded += OnSceneLoaded;
-        }
-
-        void OnDestroy()
-        {
-            SceneManager.sceneLoaded -= OnSceneLoaded;
-        }
-
-        static void StripMultiScaleAO(PostProcessResources resources)
-        {
-            resources.computeShaders.multiScaleAODownsample1 = null;
-            resources.computeShaders.multiScaleAODownsample2 = null;
-            resources.computeShaders.multiScaleAORender = null;
-            resources.computeShaders.multiScaleAOUpsample = null;
-            resources.shaders.multiScaleAO = null;
-        }
-
-        static void StripScreenSpaceReflections(PostProcessResources resources)
-        {
-            resources.shaders.screenSpaceReflections = null;
-            resources.computeShaders.gaussianDownsample = null;
-        }
-
-        static void StripDebugShaders(PostProcessResources resources)
-        {
-            resources.shaders.lightMeter = null;
-            resources.shaders.gammaHistogram = null;
-            resources.shaders.waveform = null;
-            resources.shaders.vectorscope = null;
-            resources.shaders.debugOverlays = null;
-
-            resources.computeShaders.gammaHistogram = null;
-            resources.computeShaders.waveform = null;
-            resources.computeShaders.vectorscope = null;
-        }
-
-        static string FindPostProcessStrippingConfigGUID()
+        static private string FindPostProcessStrippingConfigGUID()
         {
             var guids = AssetDatabase.FindAssets("t:PostProcessStrippingConfig", null);
             if (guids.Length > 0)
@@ -78,65 +39,82 @@ static string FindPostProcessStrippingConfigGUID()
                 return null;
         }
 
-        static public void EnsurePostProcessStrippingConfigAssetExists()
+        static public string EnsurePostProcessStrippingConfigAssetExists()
         {
             var guid = FindPostProcessStrippingConfigGUID();
             if (guid != null)
-                return;
+                return guid;
 
+            bool wasEnabled = instance.enabled;
+            instance.enabled = false;
             AssetDatabase.CreateAsset(CreateInstance<PostProcessStrippingConfig>(), DefaultStrippingConfigAssetPath);
             AssetDatabase.SaveAssets();
             AssetDatabase.Refresh();
+            instance.enabled = wasEnabled;
+            return FindPostProcessStrippingConfigGUID();
         }
 
-        void LazyLoadStrippingConfig()
+        private void LazyLoadStrippingConfig()
         {
             if (stripping != null)
                 return;
 
-            var guid = FindPostProcessStrippingConfigGUID();
+            var guid = EnsurePostProcessStrippingConfigAssetExists();
             if (guid != null)
             {
-                stripping = (PostProcessStrippingConfig) AssetDatabase.LoadAssetAtPath(AssetDatabase.GUIDToAssetPath(guid), typeof(PostProcessStrippingConfig));
+                bool wasEnabled = instance.enabled;
+                instance.enabled = false;
+                stripping = (PostProcessStrippingConfig)AssetDatabase.LoadAssetAtPath(AssetDatabase.GUIDToAssetPath(guid), typeof(PostProcessStrippingConfig));
+                instance.enabled = wasEnabled;
             }
-
-            if (stripping == null)
-                stripping = defaultConfig;
         }
 
-        void SetConfig(PostProcessStrippingConfig config)
+        void OnDestroy()
         {
-            if (config == stripping)
-                return;
+            unstrippedResources.changeHandler = null;
+        }
 
-            if (defaultConfig == null)
-                return;
+        private void StripMultiScaleAO()
+        {
+            resources.computeShaders.multiScaleAODownsample1 = null;
+            resources.computeShaders.multiScaleAODownsample2 = null;
+            resources.computeShaders.multiScaleAORender = null;
+            resources.computeShaders.multiScaleAOUpsample = null;
+            resources.shaders.multiScaleAO = null;
+        }
 
-            if (config == defaultConfig)
-                return;
+        private void StripScreenSpaceReflections()
+        {
+            resources.shaders.screenSpaceReflections = null;
+            resources.computeShaders.gaussianDownsample = null;
+        }
 
-            if (config == null)
-            {
-                stripping = defaultConfig;
-                return;
-            }
+        private void StripDebugShaders()
+        {
+            resources.shaders.lightMeter = null;
+            resources.shaders.gammaHistogram = null;
+            resources.shaders.waveform = null;
+            resources.shaders.vectorscope = null;
+            resources.shaders.debugOverlays = null;
 
-            stripping = config;
+            resources.computeShaders.gammaHistogram = null;
+            resources.computeShaders.waveform = null;
+            resources.computeShaders.vectorscope = null;
         }
 
-        void Apply(BuildTarget target, PostProcessResources resources)
+        private void Apply(BuildTarget target)
         {
-            if (defaultConfig == null)
+            if (!enabled)
                 return;
 
-            LazyLoadStrippingConfig();
-            if (stripping == null)
+            if (resources == null)
                 return;
 
             if (unstrippedResources == null)
                 return;
 
-            if (resources == null)
+            LazyLoadStrippingConfig();
+            if (stripping == null)
                 return;
 
             resources.computeShaders = unstrippedResources.computeShaders.Clone();
@@ -146,26 +124,26 @@ void Apply(BuildTarget target, PostProcessResources resources)
             if (stripping.stripUnsupportedShaders &&
                 (target == BuildTarget.Android || target == BuildTarget.iOS || target == BuildTarget.tvOS))
             {
-                StripMultiScaleAO(resources);
+                StripMultiScaleAO();
             }
 
             if (stripping.stripDebugShaders)
             {
-                StripDebugShaders(resources);
+                StripDebugShaders();
             }
 
             if (stripping.stripComputeShaders)
             {
                 resources.computeShaders = new PostProcessResources.ComputeShaders();
                 resources.shaders.autoExposure = null;
-                StripScreenSpaceReflections(resources);
-                StripMultiScaleAO(resources);
-                StripDebugShaders(resources);
+                StripScreenSpaceReflections();
+                StripMultiScaleAO();
+                StripDebugShaders();
             }
 
             if (stripping.stripUnsupportedShaders && !RuntimeUtilities.supportsDeferredShading)
             {
-                StripScreenSpaceReflections(resources);
+                StripScreenSpaceReflections();
                 resources.shaders.deferredFog = null;
                 if (!RuntimeUtilities.supportsDepthNormals)
                     resources.shaders.scalableAO = null;
@@ -180,35 +158,14 @@ void Apply(BuildTarget target, PostProcessResources resources)
             }
         }
 
-        void OnSceneLoaded(Scene scene, LoadSceneMode mode)
+        public static void Update()
         {
-            StripAll();
+            Update(EditorUserBuildSettings.activeBuildTarget);
         }
 
-        public static void Strip(PostProcessResources resources)
+        public static void Update(BuildTarget target)
         {
-            instance.Apply(EditorUserBuildSettings.activeBuildTarget, resources);
-        }
-
-        public static void StripAll(BuildTarget target)
-        {
-            var allResources = PostProcessResourcesFactory.AllResources();
-            if (allResources == null)
-                return;
-
-            foreach (var resources in allResources)
-                instance.Apply(EditorUserBuildSettings.activeBuildTarget, resources);
-        }
-
-        public static void StripAll()
-        {
-            StripAll(EditorUserBuildSettings.activeBuildTarget);
-        }
-
-        public static void StripAll(PostProcessStrippingConfig config)
-        {
-            instance.SetConfig(config);
-            StripAll(EditorUserBuildSettings.activeBuildTarget);
+            instance.Apply(EditorUserBuildSettings.activeBuildTarget);
         }
     }
 
@@ -218,7 +175,7 @@ sealed class UpdateStrippingOnBuildTargetChange : IActiveBuildTargetChanged
         public int callbackOrder { get { return 0; } }
         public void OnActiveBuildTargetChanged(BuildTarget previousTarget, BuildTarget newTarget)
         {
-            PostProcessResourceStripper.StripAll(newTarget);
+            PostProcessResourceStripper.Update(newTarget);
         }
     }
 
@@ -229,24 +186,26 @@ sealed class UpdateStrippingBeforeBuild : IPreprocessBuild
     #if UNITY_2018_1_OR_NEWER
         public void OnPreprocessBuild(Build.Reporting.BuildReport report)
         {
-            PostProcessResourceStripper.StripAll(report.summary.platform);
+            PostProcessResourceStripper.Update(report.summary.platform);
         }
+
     #else
         public void OnPreprocessBuild(BuildTarget target, string path)
         {
-            PostProcessResourceStripper.StripAll(target);
+            PostProcessResourceStripper.Update(target);
         }
+
     #endif
     }
 #endif
 
+
     [InitializeOnLoad]
-    public class SetupStripping
+    public class SetupStrippingConfig
     {
-        static SetupStripping()
+        static SetupStrippingConfig()
         {
             PostProcessResourceStripper.EnsurePostProcessStrippingConfigAssetExists();
-            PostProcessResourcesFactory.Init(PostProcessResourceStripper.Strip);
         }
     }
 }

PostProcessing/Editor/PostProcessResourceStripper.cs.meta

@@ -1,7 +1,5 @@
-using System;
 using UnityEngine;
 using UnityEditor.Rendering.PostProcessing;
-using UnityEngine.Rendering.PostProcessing;
 
 namespace UnityEditor.Rendering.PostProcessing
 {
@@ -11,39 +9,14 @@ public sealed class PostProcessStrippingConfig : ScriptableObject
         public bool stripDebugShaders = false;
         public bool stripComputeShaders = false;
 
-        [Serializable]
-        public sealed class Result
-        {
-            public PostProcessResources.Shaders shaders;
-            public PostProcessResources.ComputeShaders computeShaders;
-        }
-
-        public Result result;
-
-        private PostProcessResources strippedResources;
-
         public void Awake()
         {
-            PostProcessResourceStripper.StripAll(this);
-            UpdateResult();
+            PostProcessResourceStripper.Update();
         }
 
         public void OnValidate()
         {
-            PostProcessResourceStripper.StripAll(this);
-            UpdateResult();
-        }
-
-        private void UpdateResult()
-        {
-            if (result == null)
-                result = new Result();
-
-            PostProcessResources resources = PostProcessResourcesFactory.StrippedDefaultResources();
-            result.shaders = resources.shaders;
-            result.computeShaders = resources.computeShaders;
-            DestroyImmediate(resources);
+            PostProcessResourceStripper.Update();
         }
     }
-
 }

PostProcessing/Editor/PostProcessStrippingConfig.cs

@@ -145,9 +145,6 @@ void InitLegacy()
 
         public void Init(PostProcessResources resources)
         {
-#if UNITY_EDITOR
-            m_Resources = PostProcessResourcesFactory.Stripped(m_Resources);
-#endif
             if (resources != null) m_Resources = resources;
 
             RuntimeUtilities.CreateIfNull(ref temporalAntialiasing);