Fix ProbeVolume buffers not being reset after disable (#95)

Fixed ProbeVolume BuffersDataVersion not being reset on disable. Also clear EngineDataIndex and simulationFrameTick. Unified clearing methods.

Author: AndrewSaraevUnity

com.unity.render-pipelines.high-definition/Runtime/Lighting/ProbeVolume/DynamicGI/ProbeVolumeDynamicGI.cs

@@ -958,7 +958,7 @@ internal void DispatchPropagationOutputDynamicSH(
             cmd.DispatchCompute(shader, kernel, dispatchX, 1, 1);
         }
 
-        internal bool CleanupPropagation(ProbeVolumeHandle probeVolume)
+        internal static bool CleanupPropagation(ProbeVolumeHandle probeVolume)
         {
             ref var propagationPipelineData = ref probeVolume.GetPropagationPipelineData();
 
@@ -969,6 +969,7 @@ internal bool CleanupPropagation(ProbeVolumeHandle probeVolume)
             didDispose |= ProbeVolume.CleanupBuffer(propagationPipelineData.hitRadianceCache);
 
             propagationPipelineData.buffersDataVersion = -1;
+            propagationPipelineData.simulationFrameTick = -1;
 
             return didDispose;
         }

com.unity.render-pipelines.high-definition/Runtime/Lighting/ProbeVolume/ProbeVolume.cs

@@ -969,13 +969,10 @@ internal void EnsureVolumeBuffers()
             pipelineData.BuffersDataVersion = probeVolumeAsset.dataVersion;
         }
 
-        internal void CleanupBuffers()
-        {
-            CleanupBuffers(pipelineData);
-        }
-
-        public static void CleanupBuffers(ProbeVolumePipelineData pipelineData)
+        public static void CleanupBuffers(ProbeVolumeHandle probeVolume)
         {
+            ref var pipelineData = ref probeVolume.GetPipelineData();
+        
             CleanupBuffer(pipelineData.SHL01Buffer);
             CleanupBuffer(pipelineData.SHL2Buffer);
             CleanupBuffer(pipelineData.ValidityBuffer);
@@ -1020,6 +1017,12 @@ public static void SetBuffer<T>(ComputeBuffer buffer, T[] data)
             }
         }
 
+        public static void ReleaseVolumeFromAtlas(ProbeVolumeHandle probeVolume)
+        {
+            if (RenderPipelineManager.currentPipeline is HDRenderPipeline hdrp)
+                hdrp.ReleaseProbeVolumeFromAtlas(probeVolume);
+        }
+
 #if UNITY_EDITOR
         internal VolumeGlobalUniqueID GetBakeID()
         {

com.unity.render-pipelines.high-definition/Runtime/Lighting/ProbeVolume/ProbeVolumeLighting.cs

@@ -612,21 +612,22 @@ internal void ReleaseProbeVolumeFromAtlas(ProbeVolumeHandle volume)
             if (!m_SupportProbeVolume)
                 return;
 
-            ref ProbeVolume.ProbeVolumeAtlasKey usedKey = ref volume.GetPipelineData().UsedAtlasKey;
+            ref var pipelineData = ref volume.GetPipelineData();
 
             // TODO: Currently, this means that if there are multiple probe volumes that point to the same payload,
             // if any of them are disabled, that payload will be evicted from the atlas.
             // If will get added back to the atlas the next frame any of the remaining enabled probe volumes are seen,
             // so functionally, this is fine. It does however put additional pressure on the atlas allocator + blitting.
             // Could add reference counting to atlas keys, or could track key use timestamps and evict based on least recently used as needed.
-            if (probeVolumeAtlas.IsTextureSlotAllocated(usedKey)) { probeVolumeAtlas.ReleaseTextureSlot(usedKey); }
+            if (probeVolumeAtlas.IsTextureSlotAllocated(pipelineData.UsedAtlasKey)) { probeVolumeAtlas.ReleaseTextureSlot(pipelineData.UsedAtlasKey); }
 
             if (ShaderConfig.s_ProbeVolumesBilateralFilteringMode == ProbeVolumesBilateralFilteringModes.OctahedralDepth)
             {
-                if (probeVolumeAtlasOctahedralDepth.IsTextureSlotAllocated(usedKey)) { probeVolumeAtlasOctahedralDepth.ReleaseTextureSlot(usedKey); }
+                if (probeVolumeAtlasOctahedralDepth.IsTextureSlotAllocated(pipelineData.UsedAtlasKey)) { probeVolumeAtlasOctahedralDepth.ReleaseTextureSlot(pipelineData.UsedAtlasKey); }
             }
 
-            usedKey = ProbeVolume.ProbeVolumeAtlasKey.empty;
+            pipelineData.UsedAtlasKey = ProbeVolume.ProbeVolumeAtlasKey.empty;
+            pipelineData.EngineDataIndex = -1;
         }
 
         internal void EnsureStaleDataIsFlushedFromAtlases(ProbeVolumeHandle volume, bool isOctahedralDepthAtlasEnabled)

com.unity.render-pipelines.high-definition/Runtime/Lighting/ProbeVolume/ProbeVolumeManager.cs

@@ -71,19 +71,13 @@ internal void DeRegisterVolume(ProbeVolume volume)
                 return;
 
             var handle = new ProbeVolumeHandle(this, index);
-            ReleaseVolumeFromAtlas(handle);
-            volume.CleanupBuffers();
-            ProbeVolumeDynamicGI.instance.CleanupPropagation(handle);
+            ProbeVolume.ReleaseVolumeFromAtlas(handle);
+            ProbeVolume.CleanupBuffers(handle);
+            ProbeVolumeDynamicGI.CleanupPropagation(handle);
 
             m_Volumes.RemoveAt(index);
         }
 
-        public void ReleaseVolumeFromAtlas(ProbeVolumeHandle volume)
-        {
-            if (RenderPipelineManager.currentPipeline is HDRenderPipeline hdrp)
-                hdrp.ReleaseProbeVolumeFromAtlas(volume);
-        }
-
         public void AddProbeList(IProbeVolumeList list)
         {
             m_AdditionalProbeLists.Add(list);
@@ -142,8 +136,8 @@ void OnBakeCompleted()
 
                 // cleanup buffers
                 var handle = new ProbeVolumeHandle(this, index);
-                volume.CleanupBuffers();
-                ProbeVolumeDynamicGI.instance.CleanupPropagation(handle);
+                ProbeVolume.CleanupBuffers(handle);
+                ProbeVolumeDynamicGI.CleanupPropagation(handle);
             }
 
             if (volumesSelected.Count > 0)