View source

class FlxRuntimeShader

package flixel.addons.display

extends FlxGraphicsShader › GraphicsShader › Shader

extended by AdjustColorShader, BlendModesShader, GaussianBlurShader, Grayscale, HSVShader, InverseDotsShader, MosaicEffect, PuddleShader, RuntimePostEffectShader, WiggleEffectRuntime, ScriptedFlxRuntimeShader

@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())

Available on all platforms

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 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

See also:

Constructor

new(?fragmentSource:String, ?vertexSource:String, ?glslVersion:String)

Constructs a GLSL shader.

Parameters:

fragmentSource

The fragment shader source.

vertexSource

The vertex shader source. Note you also need to initialize() the shader MANUALLY! It can't be done automatically.

Methods

getBitmapData(name:String):Null<BitmapData>

Retrieve a bitmap data parameter of the shader.

Parameters:

name

The name of the parameter to retrieve.

Returns:

The value of the parameter.

getBool(name:String):Null<Bool>

Retrieve a boolean parameter of the shader.

Parameters:

name

The name of the parameter to retrieve.

Returns:

The value of the parameter.

getBoolArray(name:String):Null<Array<Bool>>

Retrieve a boolean array parameter of the shader.

Parameters:

name

The name of the parameter to retrieve.

Returns:

The value of the parameter.

getFloat(name:String):Null<Float>

Retrieve a float parameter of the shader.

Parameters:

name

The name of the parameter to retrieve.

Returns:

The value of the parameter.

getFloatArray(name:String):Null<Array<Float>>

Retrieve a float array parameter of the shader.

Parameters:

name

The name of the parameter to retrieve.

Returns:

The value of the parameter.

getInt(name:String):Null<Int>

Retrieve an integer parameter of the shader.

Parameters:

name

The name of the parameter to retrieve.

Returns:

The value of the parameter.

getIntArray(name:String):Null<Array<Int>>

Retrieve an integer array parameter of the shader.

Parameters:

name

The name of the parameter to retrieve.

Returns:

The value of the parameter.

setBitmapData(name:String, value:BitmapData):Void

Modify a bitmap data parameter of the shader.

Parameters:

name

The name of the parameter to modify.

value

The new value to use.

setBool(name:String, value:Bool):Void

Modify a boolean parameter of the shader.

Parameters:

name

The name of the parameter to modify.

value

The new value to use.

setBoolArray(name:String, value:Array<Bool>):Void

Modify a boolean array parameter of the shader.

Parameters:

name

The name of the parameter to modify.

value

The new value to use.

setFloat(name:String, value:Float):Void

Modify a float parameter of the shader.

Parameters:

name

The name of the parameter to modify.

value

The new value to use.

setFloatArray(name:String, value:Array<Float>):Void

Modify a float array parameter of the shader.

Parameters:

name

The name of the parameter to modify.

value

The new value to use.

setInt(name:String, value:Int):Void

Modify an integer parameter of the shader.

Parameters:

name

The name of the parameter to modify.

value

The new value to use.

setIntArray(name:String, value:Array<Int>):Void

Modify an integer array parameter of the shader.

Parameters:

name

The name of the parameter to modify.

value

The new value to use.

toString():String

Inherited Variables

Defined by FlxGraphicsShader

@:keepalpha:ShaderParameter_Float

@:keepcolorMultiplier:ShaderParameter_Float

@:keepcolorOffset:ShaderParameter_Float

@:keephasColorTransform:ShaderParameter_Bool

@:keephasTransform:ShaderParameter_Bool

@:keeppremultiplyAlpha:ShaderParameter_Bool

Defined by GraphicsShader

@:keepbitmap:ShaderInput_openfl_display_BitmapData

Defined by Shader

write onlybyteCode:ByteArray

The raw shader bytecode for this Shader instance.

data:ShaderData

Provides access to parameters, input images, and metadata for the Shader instance. ShaderParameter objects representing parameters for the shader, ShaderInput objects representing the input images for the shader, and other values representing the shader's metadata are dynamically added as properties of the data property object when the Shader instance is created. Those properties can be used to introspect the shader and to set parameter and input values. For information about accessing and manipulating the dynamic properties of the data object, see the ShaderData class description.

read onlyglFragmentBodyRaw:String

The default GLSL vertex body, before being applied to the vertex source.

glFragmentExtensions:Array<{name:String, behavior:String}>

read onlyglFragmentHeaderRaw:String

The default GLSL vertex header, before being applied to the vertex source.

glFragmentSource:String

Get or set the fragment source used when compiling with GLSL.

This property is not available on the Flash target.

read onlyglFragmentSourceRaw:String

The default GLSL fragment source, before #pragma values are replaced.

@SuppressWarnings("checkstyle:Dynamic")read onlyglProgram:GLProgram

The compiled GLProgram if available.

This property is not available on the Flash target.

glVersion:String

Get or set the GLSL version used in the header when compiling with GLSL.

  • 120 is required for initialization (i.e. providing a default value for) uniform variables

read onlyglVertexBodyRaw:String

The default GLSL vertex body, before being applied to the vertex source.

glVertexExtensions:Array<{name:String, behavior:String}>

Provides additional #extension directives to insert in the vertex and fragment shaders.

Example:

@:glExtensions([{name: "OES_standard_derivatives", behavior: "require"}])
@:glVertexExtensions([{name: "OES_standard_derivatives", behavior: "require"}])
@:glFragmentExtensions([{name: "OES_standard_derivatives", behavior: "require"}])

read onlyglVertexHeaderRaw:String

The default GLSL vertex header, before being applied to the vertex source.

glVertexSource:String

Get or set the vertex source used when compiling with GLSL.

This property is not available on the Flash target.

read onlyglVertexSourceRaw:String

The default GLSL vertex source, before #pragma values are replaced.

precisionHint:ShaderPrecision

The precision of math operations performed by the shader. The set of possible values for the precisionHint property is defined by the constants in the ShaderPrecision class.

The default value is ShaderPrecision.FULL. Setting the precision to ShaderPrecision.FAST can speed up math operations at the expense of precision.

Full precision mode (ShaderPrecision.FULL) computes all math operations to the full width of the IEEE 32-bit floating standard and provides consistent behavior on all platforms. In this mode, some math operations such as trigonometric and exponential functions can be slow.

Fast precision mode (ShaderPrecision.FAST) is designed for maximum performance but does not work consistently on different platforms and individual CPU configurations. In many cases, this level of precision is sufficient to create graphic effects without visible artifacts.

The precision mode selection affects the following shader operations. These operations are faster on an Intel processor with the SSE instruction set:

  • sin(x)
  • cos(x)
  • tan(x)
  • asin(x)
  • acos(x)
  • atan(x)
  • atan(x, y)
  • exp(x)
  • exp2(x)
  • log(x)
  • log2(x)
  • pow(x, y)
  • reciprocal(x)
  • sqrt(x)

program:Program3D

The compiled Program3D if available.

This property is not available on the Flash target.

Inherited Methods