From a9989f4001d4f116322308788d1a6d61b693bdff Mon Sep 17 00:00:00 2001
From: Wojtek Figat <wojtek@figat.pl>
Date: Thu, 14 Oct 2021 11:05:56 +0200
Subject: [PATCH] Fix Game Cooker cache when materials or particles or shaders
 format gets changed

---
 Source/Editor/Cooker/Steps/CookAssetsStep.cpp | 69 ++++++++++---------
 Source/Editor/Cooker/Steps/CookAssetsStep.h   |  5 +-
 2 files changed, 41 insertions(+), 33 deletions(-)

diff --git a/Source/Editor/Cooker/Steps/CookAssetsStep.cpp b/Source/Editor/Cooker/Steps/CookAssetsStep.cpp
index 29e45b05f..ea234ccd1 100644
--- a/Source/Editor/Cooker/Steps/CookAssetsStep.cpp
+++ b/Source/Editor/Cooker/Steps/CookAssetsStep.cpp
@@ -28,7 +28,10 @@
 #include "Engine/Streaming/StreamingSettings.h"
 #include "Engine/ShadersCompilation/ShadersCompilation.h"
 #include "Engine/Graphics/RenderTools.h"
+#include "Engine/Graphics/Shaders/GPUShader.h"
 #include "Engine/Graphics/Textures/TextureData.h"
+#include "Engine/Graphics/Materials/MaterialShader.h"
+#include "Engine/Particles/Graph/GPU/ParticleEmitterGraph.GPU.h"
 #include "Engine/Engine/Base/GameBase.h"
 #include "Engine/Engine/Globals.h"
 #include "Engine/Tools/TextureTool/TextureTool.h"
@@ -95,34 +98,12 @@ CookAssetsStep::CacheEntry& CookAssetsStep::CacheData::CreateEntry(const Asset*
     return entry;
 }
 
-void CookAssetsStep::CacheData::InvalidateShaders()
+void CookAssetsStep::CacheData::InvalidateCachePerType(const StringView& typeName)
 {
-    LOG(Info, "Invalidating cached shader assets.");
+    LOG(Info, "Invalidating cooker cache for {0} assets.", typeName);
     for (auto e = Entries.Begin(); e.IsNotEnd(); ++e)
     {
-        auto& typeName = e->Value.TypeName;
-        if (
-            typeName == Shader::TypeName ||
-            typeName == Material::TypeName ||
-            typeName == ParticleEmitter::TypeName
-        )
-        {
-            Entries.Remove(e);
-        }
-    }
-}
-
-void CookAssetsStep::CacheData::InvalidateTextures()
-{
-    LOG(Info, "Invalidating cached texture assets.");
-    for (auto e = Entries.Begin(); e.IsNotEnd(); ++e)
-    {
-        auto& typeName = e->Value.TypeName;
-        if (
-            typeName == Texture::TypeName ||
-            typeName == CubeTexture::TypeName ||
-            typeName == SpriteAtlas::TypeName
-        )
+        if (e->Value.TypeName == typeName)
         {
             Entries.Remove(e);
         }
@@ -210,14 +191,29 @@ void CookAssetsStep::CacheData::Load(CookingData& data)
 
     // Invalidate shaders and assets with shaders if need to rebuild them
     bool invalidateShaders = false;
+    if (GPU_SHADER_CACHE_VERSION != Settings.Global.ShadersVersion)
+    {
+        LOG(Info, "{0} option has been modified.", TEXT("ShadersVersion"));
+        invalidateShaders = true;
+    }
+    if (MATERIAL_GRAPH_VERSION != Settings.Global.MaterialGraphVersion)
+    {
+        LOG(Info, "{0} option has been modified.", TEXT("MaterialGraphVersion"));
+        InvalidateCachePerType(Material::TypeName);
+    }
+    if (PARTICLE_GPU_GRAPH_VERSION != Settings.Global.ParticleGraphVersion)
+    {
+        LOG(Info, "{0} option has been modified.", TEXT("ParticleGraphVersion"));
+        InvalidateCachePerType(ParticleEmitter::TypeName);
+    }
     if (buildSettings->ShadersNoOptimize != Settings.Global.ShadersNoOptimize)
     {
-        LOG(Info, "ShadersNoOptimize option has been modified.");
+        LOG(Info, "{0} option has been modified.", TEXT("ShadersNoOptimize"));
         invalidateShaders = true;
     }
     if (buildSettings->ShadersGenerateDebugData != Settings.Global.ShadersGenerateDebugData)
     {
-        LOG(Info, "ShadersGenerateDebugData option has been modified.");
+        LOG(Info, "{0} option has been modified.", TEXT("ShadersGenerateDebugData"));
         invalidateShaders = true;
     }
 #if PLATFORM_TOOLS_WINDOWS
@@ -230,7 +226,7 @@ void CookAssetsStep::CacheData::Load(CookingData& data)
                 Settings.Windows.SupportVulkan != settings->SupportVulkan;
         if (modified)
         {
-            LOG(Info, "Platform graphics backend options has been modified.");
+            LOG(Info, "{0} option has been modified.", TEXT("Platform graphics backend"));
             invalidateShaders = true;
         }
     }
@@ -244,7 +240,7 @@ void CookAssetsStep::CacheData::Load(CookingData& data)
                 Settings.UWP.SupportDX10 != settings->SupportDX10;
         if (modified)
         {
-            LOG(Info, "Platform graphics backend options has been modified.");
+            LOG(Info, "{0} option has been modified.", TEXT("Platform graphics backend"));
             invalidateShaders = true;
         }
     }
@@ -257,18 +253,24 @@ void CookAssetsStep::CacheData::Load(CookingData& data)
                 Settings.Linux.SupportVulkan != settings->SupportVulkan;
         if (modified)
         {
-            LOG(Info, "Platform graphics backend options has been modified.");
+            LOG(Info, "{0} option has been modified.", TEXT("Platform graphics backend"));
             invalidateShaders = true;
         }
     }
 #endif
     if (invalidateShaders)
-        InvalidateShaders();
+    {
+        InvalidateCachePerType(Shader::TypeName);
+        InvalidateCachePerType(Material::TypeName);
+        InvalidateCachePerType(ParticleEmitter::TypeName);
+    }
 
     // Invalidate textures if streaming settings gets modified
     if (Settings.Global.StreamingSettingsAssetId != gameSettings->Streaming || (Entries.ContainsKey(gameSettings->Streaming) && !Entries[gameSettings->Streaming].IsValid()))
     {
-        InvalidateTextures();
+        InvalidateCachePerType(Texture::TypeName);
+        InvalidateCachePerType(CubeTexture::TypeName);
+        InvalidateCachePerType(SpriteAtlas::TypeName);
     }
 }
 
@@ -1037,6 +1039,9 @@ bool CookAssetsStep::Perform(CookingData& data)
         cache.Settings.Global.ShadersNoOptimize = buildSettings->ShadersNoOptimize;
         cache.Settings.Global.ShadersGenerateDebugData = buildSettings->ShadersGenerateDebugData;
         cache.Settings.Global.StreamingSettingsAssetId = gameSettings->Streaming;
+        cache.Settings.Global.ShadersVersion = GPU_SHADER_CACHE_VERSION;
+        cache.Settings.Global.MaterialGraphVersion = MATERIAL_GRAPH_VERSION;
+        cache.Settings.Global.ParticleGraphVersion = PARTICLE_GPU_GRAPH_VERSION;
     }
 
     // Note: this step converts all the assets (even the json) into the binary files (FlaxStorage format).
diff --git a/Source/Editor/Cooker/Steps/CookAssetsStep.h b/Source/Editor/Cooker/Steps/CookAssetsStep.h
index f134d3dd9..18f79c3bf 100644
--- a/Source/Editor/Cooker/Steps/CookAssetsStep.h
+++ b/Source/Editor/Cooker/Steps/CookAssetsStep.h
@@ -96,6 +96,9 @@ public:
                 bool ShadersNoOptimize;
                 bool ShadersGenerateDebugData;
                 Guid StreamingSettingsAssetId;
+                int32 ShadersVersion;
+                int32 MaterialGraphVersion;
+                int32 ParticleGraphVersion;
             } Global;
         } Settings;
 
@@ -140,7 +143,7 @@ public:
         /// <summary>
         /// Removes all cached entries for assets that contain a texture. This forces rebuild for them.
         /// </summary>
-        void InvalidateTextures();
+        void InvalidateCachePerType(const StringView& typeName);
 
         /// <summary>
         /// Loads the cache for the given cooking data.