API Documentation for: 0.8.2
Show:

ColorFilter Class

Extends Filter
Defined in: ColorFilter:41
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:41

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

(
  • imageData
)
Boolean

Inherited from Filter: _applyFilter:177

Parameters:

  • imageData ImageData

    Target ImageData instance.

Returns:

_createWebGLRenderer

() protected

Attempt to creates a WebGLContextRenderer for fast, efficient filter rendering. Used during filter initialization. If it cannot be done, or this.useGL is set to false, then the filter is rendered normally using a Context2D.

_getFragmentShader Get fragment shader code in GLSL.

() String protected

Returns:

_getFragmentShader Get fragment shader code in GLSL. Filters are responsible for their own fragment shaders.

() String protected

Returns:

_getVertexShader Get vertex shader in GLSL code. This sets the positions of each point on the context in 3D space.

() String protected

Returns:

_initBuffers

(
  • ctx
)
protected

Inherited from Filter: _initBuffers:213

Setup the buffers and camera for the object. In this case, just create a rectangle that occupies the full stage.

Parameters:

_initShaders

(
  • ctx
)
protected

Inherited from Filter: _initShaders:156

Setup the shaders for WebGL rendering. Each filter is responsible for its own fragment shader.

Parameters:

_initUniforms

(
  • ctx
)
protected

Inherited from Filter but overwritten in _initUniforms:248

Setup the uniforms for the fragment shader. Each filter is responsible for its own fragment shader uniforms, as they are responsible for their own fragment shaders.

Parameters:

applyFilter

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

Inherited from Filter but overwritten in applyFilter:168

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

Returns a clone of this ColorFilter instance.

Returns:

ColorFilter:

A clone of the current ColorFilter instance.

getBounds

() Rectangle

Inherited from Filter but overwritten in getBounds:88

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:

Rectangle:

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

Inherited from Filter but overwritten in initialize:134

Initialization method.

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.

shaderParamSetup

(
  • gl
  • stage
  • shaderProgram
)

Inherited from Filter: shaderParamSetup:118

Assign any unique uniforms or other setup functionality here.

Parameters:

  • gl WebGLContext

    The context associated with the stage performing the render.

  • stage SpriteStage

    The stage instance that will be rendering.

  • shaderProgram ShaderProgram

    The compiled shader that is going to be sued to perform the render.

toString

() String

Inherited from Filter but overwritten in toString:114

Returns a string representation of this object.

Returns:

String:

a string representation of the instance.

Properties

alphaMultiplier

Number

Defined in alphaMultiplier:98

Alpha channel multiplier.

alphaMultiplier

Number

Defined in alphaMultiplier:98

Alpha channel multiplier.

alphaOffset

Number

Defined in alphaOffset:126

Alpha channel offset (added to value).

alphaOffset

Number

Defined in alphaOffset:126

Alpha channel offset (added to value).

blueMultiplier

Number

Defined in blueMultiplier:91

Blue channel multiplier.

blueMultiplier

Number

Defined in blueMultiplier:91

Blue channel multiplier.

blueOffset

Number

Defined in blueOffset:119

Blue channel offset (added to value).

blueOffset

Number

Defined in blueOffset:119

Blue channel offset (added to value).

FRAG_SHADER

String

Inherited from Filter: FRAG_SHADER:81

Pre-processing shader code, will be parsed before being fed in. This should be based upon SpriteStage.SHADER_FRAGMENT_BODY_REGULAR

greenMultiplier

Number

Defined in greenMultiplier:84

Green channel multiplier.

greenMultiplier

Number

Defined in greenMultiplier:84

Green channel multiplier.

greenOffset

Number

Defined in greenOffset:112

Green channel offset (added to value).

greenOffset

Number

Defined in greenOffset:112

Green channel offset (added to value).

redMultiplier

Number

Defined in redMultiplier:77

Red channel multiplier.

redMultiplier

Number

Defined in redMultiplier:77

Red channel multiplier.

redOffset

Number

Defined in redOffset:105

Red channel offset (added to value).

redOffset

Number

Defined in redOffset:105

Red channel offset (added to value).

VTX_SHADER

String

Inherited from Filter: VTX_SHADER:71

Pre-processing shader code, will be parsed before being fed in. This should be based upon SpriteStage.SHADER_VERTEX_BODY_REGULAR