AberrationFilter Class
Separates and pushes each of the colour channels apart. I.E. shift the red channel slightly left. Allows specifying the direction and the ammount it affects each channel. Great for computer glitches and VCR like effects.
See Filter for an more information on applying filters.
Constructor
AberrationFilter
-
[xDir=0]
-
[yDir=0]
-
[redMultiplier=0]
-
[greenMultiplier=0]
-
[blueMultiplier=0]
-
[originalMix=0]
-
[alphaMax=false]
Parameters:
-
[xDir=0]
Number optionalMovement in x at a multiplier of 1, specified in pixels.
-
[yDir=0]
Number optionalMovement in y at a multiplier of 1, specified in pixels.
-
[redMultiplier=0]
Number optionalMultiplier for the movement of the Red channel. Negative values allowed.
-
[greenMultiplier=0]
Number optionalMultiplier for the movement of the Green channel. Negative values allowed.
-
[blueMultiplier=0]
Number optionalMultiplier for the movement of the Blue channel. Negative values allowed.
-
[originalMix=0]
Number optionalAmount of original image to keep, 0-1.
-
[alphaMax=false]
Boolean optionalCalculate combined alpha using maximum alpha available. Creates a stronger image.
Item Index
Properties
Methods
_applyFilter
-
imageData
Parameters:
-
imageData
ImageDataTarget ImageData instance.
Returns:
applyFilter
-
ctx
-
x
-
y
-
width
-
height
-
[targetCtx=ctx]
Applies the filter to the specified context.
Parameters:
-
ctx
CanvasRenderingContext2DThe 2D context to use as the source.
-
x
NumberThe x position to use for the source rect.
-
y
NumberThe y position to use for the source rect.
-
width
NumberThe width to use for the source rect.
-
height
NumberThe height to use for the source rect.
-
[targetCtx=ctx]
CanvasRenderingContext2D optionalThe 2D context to draw the result to. Defaults to the context passed to ctx.
Returns:
If the filter was applied successfully.
clone
()
Filter
Returns a clone of this Filter instance.
Returns:
A clone of the current Filter instance.
getBounds
-
[rect]
Provides padding values for this filter. That is, how much the filter will extend the visual bounds of an object it is applied to.
Parameters:
-
[rect]
Rectangle optionalIf specified, the provided Rectangle instance will be expanded by the padding amounts and returned.
Returns:
If a rect
param was provided, it is returned. If not, either a new rectangle with the padding values, or null if no padding is required for this filter.
shaderParamSetup
-
gl
-
stage
-
shaderProgram
Assign any unique uniforms or other setup functionality here.
Parameters:
-
gl
WebGLContextThe context associated with the stage performing the render.
-
stage
StageGLThe stage instance that will be rendering.
-
shaderProgram
ShaderProgramThe compiled shader that is going to be used to perform the render.
Properties
_multiPass
Filter
private
Another filter that is required to act as part of this filter and created and managed under the hood.
Default: null
FRAG_SHADER
String
readonly
Pre-processed template shader code. It will be parsed before being fed in into the shader compiler. This should be based upon StageGL.SHADER_FRAGMENT_BODY_REGULAR
usesContext
Boolean
A flag stating that this filter uses a context draw mode and cannot be batched into imageData processing.
Default: false
VTX_SHADER
String
readonly
Pre-processed template shader code. It will be parsed before being fed in into the shader compiler. This should be based upon StageGL.SHADER_VERTEX_BODY_REGULAR