API Documentation for: 0.6.1
Show:

ColorFilter Class

Extends Filter
Defined in: ColorFilter:34
Module: EaselJS

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

Defined in ColorFilter:34

Parameters:

  • [redMultiplier=1] Number optional

    The amount to multiply against the red channel. This is a range between 0 and 1.

  • [greenMultiplier=1] Number optional

    The amount to multiply against the green channel. This is a range between 0 and 1.

  • [blueMultiplier=1] Number optional

    The amount to multiply against the blue channel. This is a range between 0 and 1.

  • [alphaMultiplier=1] Number optional

    The amount to multiply against the alpha channel. This is a range between 0 and 1.

  • [redOffset=0] Number optional

    The amount to add to the red channel after it has been multiplied. This is a range between -255 and 255.

  • [greenOffset=0] Number optional

    The amount to add to the green channel after it has been multiplied. This is a range between -255 and 255.

  • [blueOffset=0] Number optional

    The amount to add to the blue channel after it has been multiplied. This is a range between -255 and 255.

  • [alphaOffset=0] Number optional

    The amount to add to the alpha channel after it has been multiplied. This is a range between -255 and 255.

Methods

applyFilter

(
  • ctx
  • x
  • y
  • width
  • height
  • [targetCtx]
  • [targetX]
  • [targetY]
)
Boolean

Inherited from Filter: applyFilter:88

Applies the filter to the specified context.

Parameters:

  • ctx CanvasRenderingContext2D

    The 2D context to use as the source.

  • x Number

    The x position to use for the source rect.

  • y Number

    The y position to use for the source rect.

  • width Number

    The width to use for the source rect.

  • height Number

    The height to use for the source rect.

  • [targetCtx] CanvasRenderingContext2D optional

    The 2D context to draw the result to. Defaults to the context passed to ctx.

  • [targetX] Number optional

    The x position to draw the result to. Defaults to the value passed to x.

  • [targetY] Number optional

    The y position to draw the result to. Defaults to the value passed to y.

Returns:

Boolean: If the filter was applied successfully.

clone

() ColorFilter

Inherited from Filter but overwritten in clone:173

Returns a clone of this ColorFilter instance.

Returns:

ColorFilter: A clone of the current ColorFilter instance.

getBounds

() Rectangle

Inherited from Filter: getBounds:77

Returns a rectangle with values indicating the margins required to draw the filter. 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:

Rectangle: a rectangle object indicating the margins required to draw the filter.

initialize

() protected

Inherited from Filter but overwritten in initialize:129

Initialization method.

toString

() String

Inherited from Filter: toString:103

Returns a string representation of this object.

Returns:

String: a string representation of the instance.

Properties

alphaOffset

Number

Defined in alphaOffset:121

Alpha channel offset (added to value).

blueMultiplier

Number

Defined in blueMultiplier:86

Blue channel multiplier.

blueOffset

Number

Defined in blueOffset:114

Blue channel offset (added to value).

greenMultiplier

Number

Defined in greenMultiplier:79

Green channel multiplier.

greenOffset

Number

Defined in greenOffset:107

Green channel offset (added to value).

redMultiplier

Number

Defined in redMultiplier:72

Red channel multiplier.

redMultiplier

Number

Defined in redMultiplier:93

Alpha channel multiplier.

redOffset

Number

Defined in redOffset:100

Red channel offset (added to value).