Shader caches: add configurable version number to force reset, allow manual saving

Author: trethaller

h3d/impl/ShaderCache.hx

@@ -14,10 +14,12 @@ class ShaderCache {
 	var sourceFile : String;
 	public var keepSource : Bool;
 	var mode : ShaderCacheMode;
+	var dirty = true;
+	public var allowSave = true;
 
-	inline static var VERSION_KEY_WORD = "VERSION";
-	inline static var VERSION = 1;
-	inline static var MODE_KEY_WORD = "MODE";
+	public static var VERSION_KEY_WORD = "VERSION";
+	public static var VERSION = 1;
+	public static var MODE_KEY_WORD = "MODE";
 
 	public function new( file : String, ?outputFile : String, mode = Base64) {
 		this.file = file;
@@ -26,16 +28,17 @@ class ShaderCache {
 		sourceFile = file + ".source";
 	}
 
+	@:deprecated("use allowSave = false")
 	public function disableSave() {
-		outputFile = null;
+		allowSave = false;
 	}
 
 	public function initEmpty() {
 		data = [];
 		sources = [];
 	}
 
-	function load() {
+	public function load() {
 		data = new Map();
 		try loadFile(file) catch( e : Dynamic ) {};
 		if( outputFile != file ) try loadFile(outputFile) catch( e : Dynamic ) {};
@@ -54,8 +57,13 @@ class ShaderCache {
 		var curPos = cache.position;
 		if ( !hasVersion )
 			cache.position = curPos = 0;
-		else
-			cache.readInt32();
+		else {
+			var version = cache.readInt32();
+			if(version != VERSION) {
+				trace('Shader cache version $version, expected $VERSION, skipping');
+				return;
+			}
+		}
 
 		var hasMode = cache.readString(MODE_KEY_WORD.length) == MODE_KEY_WORD;
 		var mode = Base64;
@@ -135,7 +143,8 @@ class ShaderCache {
 
 	var saveTimer : haxe.Timer;
 	public function saveCompiledShader( source : String, bytes : haxe.io.Bytes, ?configurationKey = "", ?saveToFile = true ) {
-		if( outputFile == null )
+		dirty = true;
+		if( !allowSave )
 			return;
 		if( data == null ) load();
 		var key = configurationKey + haxe.crypto.Md5.encode(source);
@@ -156,7 +165,10 @@ class ShaderCache {
 		}, 100);
 	}
 
-	function save() {
+	public function save() {
+		if( !dirty )
+			return;
+		dirty = false;
 		var out = new haxe.io.BytesOutput();
 		var keys = Lambda.array({ iterator : data.keys });
 		keys.sort(Reflect.compare);

hxsl/CacheFile2.hx

@@ -253,10 +253,11 @@ class CacheFile2Loader {
 class CacheFile2 extends Cache {
 	static var DEBUG : Bool = false;
 	static var LOAD_TIME : Float = 0.0;
+	public static var VERSION = 1;
 
 	var file : String;
 	var outFile : String;
-	var allowSave : Bool;
+	public var allowSave : Bool;
 
 	var isLoading : Bool = false;
 	var isDirty(default, set) : Bool = false;
@@ -367,7 +368,7 @@ class CacheFile2 extends Cache {
 		}
 
 		var magic = readLine();
-		if( !StringTools.startsWith(magic, "CF2-1") ) {
+		if( !StringTools.startsWith(magic, 'CF2-$VERSION') ) {
 			f.close();
 			return false;
 		}
@@ -469,11 +470,11 @@ class CacheFile2 extends Cache {
 		return true;
 	}
 
-	function saveIfModified() {
+	public function saveIfModified() {
 		if( this.isDirty ) {
 			this.isDirty = false;
 			#if !shader_debug_dump
-			save();
+			_save();
 			#end
 		}
 	}
@@ -615,11 +616,9 @@ class CacheFile2 extends Cache {
 		sys.io.File.saveContent(path, out.join("\n"));
 	}
 
-	function save() {
-		if( !allowSave ) return;
-
+	function _save() {
 		var out = new haxe.io.BytesOutput();
-		out.writeString("CF2-1\n", UTF8); // magic-version
+		out.writeString('CF2-$VERSION\n', UTF8);
 
 		linkers.sort((l1, l2) -> Reflect.compare(l1.name, l2.name));
 		for( lk in linkers ) {