Funkin changes

flixel/addons/display/FlxRuntimeShader.hx

@@ -14,30 +14,29 @@ import lime.utils.Float32Array;
 import openfl.display.BitmapData;
 import openfl.display.ShaderInput;
 import openfl.display.ShaderParameter;
-import openfl.display.ShaderParameterType;
-
-using StringTools;
 
 /**
  * An wrapper for Flixel/OpenFL's shaders, which takes fragment and vertex source
- * in the constructor instead of using macros so it can be provided at runtime.
- * 
+ * in the constructor instead of using macros, so it can be provided data
+ * at runtime (for example, when using mods).
+ *
+ * HOW TO USE:
+ * 1. Create an instance of this class, passing the text of the `.frag` and `.vert` files.
+ *    Note that you can set either of these to null (making them both null would make the shader do nothing???).
+ * 2. Use `flxSprite.shader = runtimeShader` to apply the shader to the sprite.
+ * 3. Use `runtimeShader.setFloat()`, `setBool()` etc. to modify any uniforms.
+ * 4. Use `setBitmapData()` to add additional textures as `sampler2D` uniforms
+ *
  * @author MasterEric
- * @author Mihai Alexandru (M.A. Jigsaw)
- * 
  * @see https://github.com/openfl/openfl/blob/develop/src/openfl/utils/_internal/ShaderMacro.hx
  * @see https://dixonary.co.uk/blog/shadertoy
  */
 class FlxRuntimeShader extends FlxGraphicsShader
 {
 	/**
-	 * Creates a `FlxRuntimeShader` with specified shader sources.
-	 * If none is provided, it will use the default shader sources.
-	 *
-	 * @param fragmentSource The fragment shader source.
-	 * @param vertexSource The vertex shader source.
+	 * Replace the `#pragma header` and `#pragma body` with the fragment shader header and body.
 	 */
-	public function new(?fragmentSource:String, ?vertexSource:String):Void
+	@:noCompletion private function __processFragmentSource(input:String):String
 	{
 		if (fragmentSource != null && fragmentSource.length > 0)
 			glFragmentSource = fragmentSource;
@@ -49,7 +48,14 @@ class FlxRuntimeShader extends FlxGraphicsShader
 		else
 			glVertexSource = FlxRuntimeShaderMacro.retrieveMetadata('glVertexSource', false);
 
-		super();
+	/**
+	 * Replace the `#pragma header` and `#pragma body` with the vertex shader header and body.
+	 */
+	@:noCompletion private function __processVertexSource(input:String):String
+	{
+		var result = StringTools.replace(input, PRAGMA_HEADER, glVertexHeaderRaw);
+		result = StringTools.replace(result, PRAGMA_BODY, glVertexBodyRaw);
+		return result;
 	}
 
 	/**
@@ -72,11 +78,12 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Retrieve a float parameter of the shader.
+	 * Modify a float array parameter of the shader.
 	 *
-	 * @param name The name of the parameter to retrieve.
+	 * @param name The name of the parameter to modify.
+	 * @param value The new value to use.
 	 */
-	public function getFloat(name:String):Null<Float>
+	public function setFloatArray(name:String, value:Array<Float>):Void
 	{
 		final shaderParameter:ShaderParameter<Float> = Reflect.field(data, name);
 
@@ -90,12 +97,12 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Modify a float array parameter of the shader.
+	 * Modify an integer parameter of the shader.
 	 *
 	 * @param name The name of the parameter to modify.
 	 * @param value The new value to use.
 	 */
-	public function setFloatArray(name:String, value:Array<Float>):Void
+	public function setInt(name:String, value:Int):Void
 	{
 		final shaderParameter:ShaderParameter<Float> = Reflect.field(data, name);
 
@@ -109,11 +116,12 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Retrieve a float array parameter of the shader.
+	 * Modify an integer array parameter of the shader.
 	 *
-	 * @param name The name of the parameter to retrieve.
+	 * @param name The name of the parameter to modify.
+	 * @param value The new value to use.
 	 */
-	public function getFloatArray(name:String):Null<Array<Float>>
+	public function setIntArray(name:String, value:Array<Int>):Void
 	{
 		final shaderParameter:ShaderParameter<Float> = Reflect.field(data, name);
 
@@ -127,12 +135,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Modify an integer parameter of the shader.
-	 *
+	 * Modify a boolean parameter of the shader.
 	 * @param name The name of the parameter to modify.
 	 * @param value The new value to use.
 	 */
-	public function setInt(name:String, value:Int):Void
+	public function setBool(name:String, value:Bool):Void
 	{
 		final shaderParameter:ShaderParameter<Int> = Reflect.field(data, name);
 
@@ -146,11 +153,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Retrieve an integer parameter of the shader.
-	 *
-	 * @param name The name of the parameter to retrieve.
+	 * Modify a boolean array parameter of the shader.
+	 * @param name The name of the parameter to modify.
+	 * @param value The new value to use.
 	 */
-	public function getInt(name:String):Null<Int>
+	public function setBoolArray(name:String, value:Array<Bool>):Void
 	{
 		final shaderParameter:ShaderParameter<Int> = Reflect.field(data, name);
 
@@ -164,12 +171,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Modify an integer array parameter of the shader.
-	 *
+	 * Modify a bitmap data parameter of the shader.
 	 * @param name The name of the parameter to modify.
 	 * @param value The new value to use.
 	 */
-	public function setIntArray(name:String, value:Array<Int>):Void
+	public function setBitmapData(name:String, value:openfl.display.BitmapData):Void
 	{
 		final shaderParameter:ShaderParameter<Int> = Reflect.field(data, name);
 
@@ -183,11 +189,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Retrieve an integer array parameter of the shader.
-	 *
+	 * Retrieve a float parameter of the shader.
 	 * @param name The name of the parameter to retrieve.
+	 * @return The value of the parameter.
 	 */
-	public function getIntArray(name:String):Null<Array<Int>>
+	public function getFloat(name:String):Null<Float>
 	{
 		final shaderParameter:ShaderParameter<Int> = Reflect.field(data, name);
 
@@ -201,12 +207,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Modify a bool parameter of the shader.
-	 *
-	 * @param name The name of the parameter to modify.
-	 * @param value The new value to use.
+	 * Retrieve a float array parameter of the shader.
+	 * @param name The name of the parameter to retrieve.
+	 * @return The value of the parameter.
 	 */
-	public function setBool(name:String, value:Bool):Void
+	public function getFloatArray(name:String):Null<Array<Float>>
 	{
 		final shaderParameter:ShaderParameter<Bool> = Reflect.field(data, name);
 
@@ -220,11 +225,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Retrieve a bool parameter of the shader.
-	 *
+	 * Retrieve an integer parameter of the shader.
 	 * @param name The name of the parameter to retrieve.
+	 * @return The value of the parameter.
 	 */
-	public function getBool(name:String):Null<Bool>
+	public function getInt(name:String):Null<Int>
 	{
 		final shaderParameter:ShaderParameter<Bool> = Reflect.field(data, name);
 
@@ -238,12 +243,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Modify a bool array parameter of the shader.
-	 *
-	 * @param name The name of the parameter to modify.
-	 * @param value The new value to use.
+	 * Retrieve an integer array parameter of the shader.
+	 * @param name The name of the parameter to retrieve.
+	 * @return The value of the parameter.
 	 */
-	public function setBoolArray(name:String, value:Array<Bool>):Void
+	public function getIntArray(name:String):Null<Array<Int>>
 	{
 		final shaderParameter:ShaderParameter<Bool> = Reflect.field(data, name);
 
@@ -257,11 +261,11 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	}
 
 	/**
-	 * Retrieve a bool array parameter of the shader.
-	 *
+	 * Retrieve a boolean parameter of the shader.
 	 * @param name The name of the parameter to retrieve.
+	 * @return The value of the parameter.
 	 */
-	public function getBoolArray(name:String):Null<Array<Bool>>
+	public function getBool(name:String):Null<Bool>
 	{
 		final shaderParameter:ShaderParameter<Bool> = Reflect.field(data, name);
 
@@ -280,7 +284,7 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	 * @param name The name of the parameter to modify.
 	 * @param value The new value to use.
 	 */
-	public function setSampler2D(name:String, value:BitmapData):Void
+	public function getBoolArray(name:String):Null<Array<Bool>>
 	{
 		final shaderInput:ShaderInput<BitmapData> = Reflect.field(data, name);
 
@@ -299,7 +303,7 @@ class FlxRuntimeShader extends FlxGraphicsShader
 	 * @param name The name of the parameter to retrieve.
 	 * @return The value of the parameter.
 	 */
-	public function getSampler2D(name:String):Null<BitmapData>
+	public function getBitmapData(name:String):Null<openfl.display.BitmapData>
 	{
 		final shaderInput:ShaderInput<BitmapData> = Reflect.field(data, name);
 
@@ -530,4 +534,3 @@ class FlxRuntimeShader extends FlxGraphicsShader
 		return __glVertexSource = value;
 	}
 }
-#end