ColorFilter Class
Applies a color transform to DisplayObjects.
Example
This example draws a red circle, and then transforms it to Blue. This is accomplished by multiplying all the channels to 0 (except alpha, which is set to 1), and then adding 255 to the blue channel. var shape = new createjs.Shape().set({x:100,y:100});
shape.graphics.beginFill("#ff0000").drawCircle(0,0,50);
shape.filters = [
new createjs.ColorFilter(0,0,0,1, 0,0,255,0)
];
shape.cache(50, 50, 100, 100);
See Filter for an more information on applying filters.
Constructor
ColorFilter

[redMultiplier=1]

[greenMultiplier=1]

[blueMultiplier=1]

[alphaMultiplier=1]

[redOffset=0]

[greenOffset=0]

[blueOffset=0]

[alphaOffset=0]
Parameters:

[redMultiplier=1]
Number optionalThe amount to multiply against the red channel. This is a range between 0 and 1.

[greenMultiplier=1]
Number optionalThe amount to multiply against the green channel. This is a range between 0 and 1.

[blueMultiplier=1]
Number optionalThe amount to multiply against the blue channel. This is a range between 0 and 1.

[alphaMultiplier=1]
Number optionalThe amount to multiply against the alpha channel. This is a range between 0 and 1.

[redOffset=0]
Number optionalThe amount to add to the red channel after it has been multiplied. This is a range between 255 and 255.

[greenOffset=0]
Number optionalThe amount to add to the green channel after it has been multiplied. This is a range between 255 and 255.

[blueOffset=0]
Number optionalThe amount to add to the blue channel after it has been multiplied. This is a range between 255 and 255.

[alphaOffset=0]
Number optionalThe amount to add to the alpha channel after it has been multiplied. This is a range between 255 and 255.
Item Index
Methods
Methods
applyFilter

ctx

x

y

width

height

[targetCtx]

[targetX]

[targetY]
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]
CanvasRenderingContext2D optionalThe 2D context to draw the result to. Defaults to the context passed to ctx.

[targetX]
Number optionalThe x position to draw the result to. Defaults to the value passed to x.

[targetY]
Number optionalThe y position to draw the result to. Defaults to the value passed to y.
Returns:
If the filter was applied successfully.
clone
()
ColorFilter
Returns a clone of this ColorFilter instance.
Returns:
A clone of the current ColorFilter instance.
getBounds
()
Rectangle
Returns a rectangle with values indicating the margins required to draw the filter or null. For example, a filter that will extend the drawing area 4 pixels to the left, and 7 pixels to the right (but no pixels up or down) would return a rectangle with (x=4, y=0, width=11, height=0).
Returns:
a rectangle object indicating the margins required to draw the filter or null if the filter does not effect bounds.
initialize

[redMultiplier=1]

[greenMultiplier=1]

[blueMultiplier=1]

[alphaMultiplier=1]

[redOffset=0]

[greenOffset=0]

[blueOffset=0]

[alphaOffset=0]
Initialization method.
Parameters:

[redMultiplier=1]
Number optionalThe amount to multiply against the red channel. This is a range between 0 and 1.

[greenMultiplier=1]
Number optionalThe amount to multiply against the green channel. This is a range between 0 and 1.

[blueMultiplier=1]
Number optionalThe amount to multiply against the blue channel. This is a range between 0 and 1.

[alphaMultiplier=1]
Number optionalThe amount to multiply against the alpha channel. This is a range between 0 and 1.

[redOffset=0]
Number optionalThe amount to add to the red channel after it has been multiplied. This is a range between 255 and 255.

[greenOffset=0]
Number optionalThe amount to add to the green channel after it has been multiplied. This is a range between 255 and 255.

[blueOffset=0]
Number optionalThe amount to add to the blue channel after it has been multiplied. This is a range between 255 and 255.

[alphaOffset=0]
Number optionalThe amount to add to the alpha channel after it has been multiplied. This is a range between 255 and 255.