API Documentation for: 0.8.2
Show:

ColorMatrixFilter Class

Extends Filter
Defined in: ColorMatrixFilter:41
Module: EaselJS

Allows you to carry out complex color operations such as modifying saturation, brightness, or inverting. See the ColorMatrix for more information on changing colors. For an easier color transform, consider the ColorFilter.

Example

This example creates a red circle, inverts its hue, and then saturates it to brighten it up.

 var shape = new createjs.Shape().set({x:100,y:100});
 shape.graphics.beginFill("#ff0000").drawCircle(0,0,50);

 var matrix = new createjs.ColorMatrix().adjustHue(180).adjustSaturation(100);
 shape.filters = [
     new createjs.ColorMatrixFilter(matrix)
 ];

 shape.cache(-50, -50, 100, 100);

See Filter for an more information on applying filters.

Constructor

ColorMatrixFilter

(
  • matrix
)

Parameters:

  • matrix Array

    A 4x5 matrix describing the color operation to perform. See also the ColorMatrix class.

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

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

() ColorMatrixFilter

Inherited from Filter but overwritten in clone:169

Returns a clone of this ColorMatrixFilter instance.

Returns:

ColorMatrixFilter:

A clone of the current ColorMatrixFilter 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

(
  • matrix
)
protected

Inherited from Filter but overwritten in initialize:74

Parameters:

  • matrix Array

    A 4x5 matrix describing the color operation to perform.

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

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

matrix

Array | ColorMatrix

Defined in matrix:70

A 4x5 matrix describing the color operation to perform. See also the ColorMatrix

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