Skip to content

fix: clear shader cache on plugin version change #1739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alandtse merged 10 commits into from
Feb 2, 2026
Merged

fix: clear shader cache on plugin version change #1739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f1e79bf
Initial plan
Copilot Jan 20, 2026
de35c06
Add plugin version check to shader cache validation
Copilot Jan 20, 2026
8c0a252
Address code review feedback
Copilot Jan 20, 2026
6d9f538
Make feature validation unconditional for consistency
Copilot Jan 20, 2026
181aa03
Final implementation complete
Copilot Jan 20, 2026
e11b943
Remove accidentally committed CodeQL artifact file
Copilot Jan 20, 2026
774b8e1
Format log statement on single line for readability
Copilot Jan 22, 2026
0bafaf4
Remove SHADER_CACHE_VERSION and rely solely on Plugin::VERSION
Copilot Jan 22, 2026
b84ef95
Merge branch 'dev' into copilot/add-auto-clear-shader-cache
alandtse Jan 31, 2026
4b04702
Merge branch 'dev' into copilot/add-auto-clear-shader-cache
alandtse Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions src/ShaderCache.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

#include "Features/DynamicCubemaps.h"

#include "Plugin.h"

namespace SIE
{
namespace SShaderCache
Expand Down Expand Up @@ -2190,13 +2192,21 @@ namespace SIE
ini.LoadFile(L"Data\\ShaderCache\\Info.ini");
bool valid = true;

if (auto version = ini.GetValue("Cache", "Version")) {
if (strcmp(SHADER_CACHE_VERSION.string().c_str(), version) != 0 || !(globals::state->ValidateCache(ini))) {
logger::info("Disk cache outdated or invalid");
// Check plugin version
if (auto pluginVersion = ini.GetValue("Cache", "PluginVersion")) {
if (strcmp(Plugin::VERSION.string().c_str(), pluginVersion) != 0) {
logger::info("Disk cache outdated: plugin version changed (current: {}, cached: {})",
Plugin::VERSION.string(), pluginVersion);
valid = false;
}
} else {
logger::info("Disk cache outdated or invalid");
logger::info("Disk cache outdated: no plugin version found");
valid = false;
}

// Check feature validation
if (!(globals::state->ValidateCache(ini))) {
logger::info("Disk cache outdated: feature validation failed");
valid = false;
}

Expand All @@ -2211,10 +2221,10 @@ namespace SIE
{
CSimpleIniA ini;
ini.SetUnicode();
ini.SetValue("Cache", "Version", SHADER_CACHE_VERSION.string().c_str());
ini.SetValue("Cache", "PluginVersion", Plugin::VERSION.string().c_str());
globals::state->WriteDiskCacheInfo(ini);
ini.SaveFile(L"Data\\ShaderCache\\Info.ini");
logger::info("Saved disk cache info");
logger::info("Saved disk cache info (plugin version: {})", Plugin::VERSION.string());
}

ShaderCache::ShaderCache()
Expand Down
2 changes: 0 additions & 2 deletions src/ShaderCache.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
#include <BS_thread_pool.hpp>
#include <efsw/efsw.hpp>

static constexpr REL::Version SHADER_CACHE_VERSION = { 0, 0, 0, 42 };

using namespace std::chrono;

namespace ShaderConstants
Expand Down