Applies a color correction filter based on the provided matrix.

Matrix values are as following:

     red        green      blue       alpha
[   redMult,   redMult,   redMult,   redMult ]
[ greenMult, greenMult, greenMult, greenMult ]
[  blueMult,  blueMult,  blueMult,  blueMult ]
[ alphaMult, alphaMult, alphaMult, alphaMult ]

An identity matrix will result in an unmodified colors:

[1, 0, 0, 0]
[0, 1, 0, 0]
[0, 0, 1, 0]
[0, 0, 0, 1]

See also:

Static methods


Returns a ColorMatrix filter which results in a grayscale image (0 saturation).



Create a new ColorMatrix filter.



The matrix used to modify the resulting colors.



The matrix used to apply color correction.


Inherited Variables

Defined by Filter

@:value(true)autoBounds:Bool = true

When enabled, rendering bounds of the filter will be expanded by Filter.boundsExtend in all directions. Otherwise filter should provide custom bounds through Filter.getBounds call.
Default : true.

@:value(0.)boundsExtend:Float = 0.

Rendering texture boundaries extent. Increases the rendering area by twice the Filter.boundsExtend value.
Automatically applied to object bounds when autoBounds = true or Filter.getBounds is not overridden.
Does not affect boundaries when autoBounds = true and boundsExtend is less than 0.

@:value(true)@:isVarenable:Bool = true

When filter is disabled, attached object will render as usual.

@:value(false)smooth:Bool = false

When enabled, some filters will use bilinear filtering on temporary textures.
Does not affect the majority of filters.

See also:

Inherited Methods

Defined by Filter


Sent when filter is bound to an Object s. If Object was not yet allocated, method will be called when it's added to allocated Scene.

getBounds(s:Object, bounds:Bounds):Void

Method should populate bounds with rendering boundaries of the Filter for Object s. Initial bounds contents are undefined and it's recommended to either clear them or call s.getBounds(s, bounds). Only used when Filter.autoBounds is false. By default uses given Object bounds and extends them with Filter.boundsExtend. Compared to autoBounds = true, negative boundsExtend is still applied, causing rendering area to shrink.

sync(ctx:RenderContext, s:Object):Void

Used to sync data for rendering.


Sent when filter was unbound from an Object s. Method won't be called if Object was not yet allocated.