Cache base types of Volume Manager to improve perf/memory #3804

Author: JulienIgnace-Unity

com.unity.render-pipelines.core/Editor/Volume/VolumeComponentProvider.cs

@@ -51,7 +51,7 @@ public void CreateComponentTree(List<Element> tree)
         {
             tree.Add(new GroupElement(0, "Volume Overrides"));
 
-            var types = VolumeManager.instance.baseComponentTypes;
+            var types = VolumeManager.instance.baseComponentTypeArray;
             var rootNode = new PathNode();
 
             foreach (var t in types)

com.unity.render-pipelines.core/Runtime/Volume/VolumeManager.cs

@@ -30,7 +30,20 @@ public sealed class VolumeManager
         /// <summary>
         /// The current list of all available types that derive from <see cref="VolumeComponent"/>.
         /// </summary>
-        public IEnumerable<Type> baseComponentTypes { get; private set; }
+        [Obsolete("Please use baseComponentTypeArray instead.")]
+        public IEnumerable<Type> baseComponentTypes
+        {
+            get
+            {
+                return baseComponentTypeArray;
+            }
+            private set
+            {
+                baseComponentTypeArray = value.ToArray();
+            }
+        }
+
+        public Type[] baseComponentTypeArray { get; private set; }
 
         // Max amount of layers available in Unity
         const int k_MaxLayerCount = 32;
@@ -75,7 +88,7 @@ public sealed class VolumeManager
         public VolumeStack CreateStack()
         {
             var stack = new VolumeStack();
-            stack.Reload(baseComponentTypes);
+            stack.Reload(baseComponentTypeArray);
             return stack;
         }
 
@@ -95,12 +108,12 @@ void ReloadBaseTypes()
             m_ComponentsDefaultState.Clear();
 
             // Grab all the component types we can find
-            baseComponentTypes = CoreUtils.GetAllTypesDerivedFrom<VolumeComponent>()
-                .Where(t => !t.IsAbstract);
+            baseComponentTypeArray = CoreUtils.GetAllTypesDerivedFrom<VolumeComponent>()
+                .Where(t => !t.IsAbstract).ToArray();
 
             // Keep an instance of each type to be used in a virtual lowest priority global volume
             // so that we have a default state to fallback to when exiting volumes
-            foreach (var type in baseComponentTypes)
+            foreach (var type in baseComponentTypeArray)
             {
                 var inst = (VolumeComponent)ScriptableObject.CreateInstance(type);
                 m_ComponentsDefaultState.Add(inst);
@@ -260,15 +273,15 @@ public void CheckStack(VolumeStack stack)
 
             if (components == null)
             {
-                stack.Reload(baseComponentTypes);
+                stack.Reload(baseComponentTypeArray);
                 return;
             }
 
             foreach (var kvp in components)
             {
                 if (kvp.Key == null || kvp.Value == null)
                 {
-                    stack.Reload(baseComponentTypes);
+                    stack.Reload(baseComponentTypeArray);
                     return;
                 }
             }

com.unity.render-pipelines.core/Runtime/Volume/VolumeStack.cs

@@ -18,7 +18,7 @@ internal VolumeStack()
         {
         }
 
-        internal void Reload(IEnumerable<Type> baseTypes)
+        internal void Reload(Type[] baseTypes)
         {
             if (components == null)
                 components = new Dictionary<Type, VolumeComponent>();

com.unity.render-pipelines.high-definition/CHANGELOG.md

@@ -166,6 +166,7 @@ The version number for this package has increased due to a version update of a r
 - Transparent materials created by the Model Importer are set to not cast shadows. ( case 1295747)
 - Change some light unit slider value ranges to better reflect the lighting scenario.
 - Change the tooltip for color shadows and semi-transparent shadows (case 1307704).
+- Cached the base types of Volume Manager to improve memory and cpu usage.
 
 ## [10.2.1] - 2020-11-30
 

com.unity.render-pipelines.high-definition/Runtime/Debug/VolumeDebug.cs

@@ -132,7 +132,7 @@ static public List<Type> componentTypes
             {
                 if (s_ComponentTypes == null)
                 {
-                    s_ComponentTypes = VolumeManager.instance.baseComponentTypes
+                    s_ComponentTypes = VolumeManager.instance.baseComponentTypeArray
                     .Where(t => !t.IsDefined(typeof(VolumeComponentDeprecated), false))
                     .OrderBy(t => ComponentDisplayName(t))
                     .ToList();