#

API Documentation for: NEXT
Show: Inherited Protected Private Deprecated

# ColorMatrixFilter Class

Extends Filter
Defined in: `ColorMatrixFilter:39`
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`

)

Defined in `ColorMatrixFilter:39`

#### Parameters:

- `matrix` Array

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

- Index
- Methods

## Item Index

### Methods

- applyFilter
- clone
- getBounds
- initialize
- toString

## Methods

### `applyFilter`

(

- `ctx`
- `x`
- `y`
- `width`
- `height`
- `[targetCtx]`
- `[targetX]`
- `[targetY]`

)
Boolean

Inherited from Filter: `applyFilter:94`

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`

() ColorMatrixFilter

Inherited from Filter but overwritten in `clone:121`

Returns a clone of this ColorMatrixFilter instance.

#### Returns:

ColorMatrixFilter:

A clone of the current ColorMatrixFilter instance.

### `getBounds`

() Rectangle

Inherited from Filter: `getBounds:83`

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.

### `toString`

() String

Inherited from Filter: `toString:109`

Returns a string representation of this object.

#### Returns:

String:

a string representation of the instance.