API Documentation for: 0.6.0
Show:

ColorFilter Class

Extends Filter
Defined in: ColorFilter:34
Module: EaselJS

Applies color transforms.

See Filter for an example of how to apply filters.

Constructor

ColorFilter

(
  • redMultiplier
  • greenMultiplier
  • blueMultiplier
  • alphaMultiplier
  • redOffset
  • greenOffset
  • blueOffset
  • alphaOffset
)

Defined in ColorFilter:34

Parameters:

Methods

applyFilter

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

Inherited from Filter but overwritten in applyFilter:130

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:

clone

() ColorFilter

Inherited from Filter but overwritten in clone:176

Returns a clone of this ColorFilter instance.

Returns:

ColorFilter: A clone of the current ColorFilter instance.

getBounds

() Rectangle

Inherited from Filter: getBounds:73

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

Initialization method.

toString

() String

Inherited from Filter but overwritten in toString:166

Returns a string representation of this object.

Returns:

String: a string representation of the instance.

Properties

alphaOffset

Number

Defined in alphaOffset:105

Alpha channel offset (added to value).

blueMultiplier

Number

Defined in blueMultiplier:70

Blue channel multiplier.

blueOffset

Number

Defined in blueOffset:98

Blue channel offset (added to value).

greenMultiplier

Number

Defined in greenMultiplier:63

Green channel multiplier.

greenOffset

Number

Defined in greenOffset:91

Green channel offset (added to value).

redMultiplier

Number

Defined in redMultiplier:56

Red channel multiplier.

redMultiplier

Number

Defined in redMultiplier:77

Alpha channel multiplier.

redOffset

Number

Defined in redOffset:84

Red channel offset (added to value).