#

API Documentation for: NEXT
Show: Inherited Protected Private Deprecated

# 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`

)

Defined in `ColorMatrixFilter:41`

#### Parameters:

- `matrix` Array | ColorMatrix

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

- Index
- Methods
- Properties

## Item Index

### Methods

- _applyFilter
- applyFilter
- clone
- getBounds
- initialize deprecated
- toString

### Properties

- matrix

## Methods

### `_applyFilter`

(

- `imageData`

)
Boolean

Inherited from Filter: `_applyFilter:148`

#### Parameters:

- `imageData` ImageData

  Target ImageData instance.

#### Returns:

Boolean:

### `applyFilter`

(

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

)
Boolean

Inherited from Filter: `applyFilter:99`

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`

() Filter

Inherited from Filter: `clone:138`

Returns a clone of this Filter instance.

#### Returns:

Filter:

A clone of the current Filter instance.

### `getBounds`

(

- `[rect]`

)
Rectangle

Inherited from Filter: `getBounds:89`

Provides padding values for this filter. That is, how much the filter will extend the visual bounds of an object it is applied to.

#### Parameters:

- `[rect]` Rectangle optional

  If specified, the provided Rectangle instance will be expanded by the padding amounts and returned.

#### Returns:

Rectangle:

If a `rect` param was provided, it is returned. If not, either a new rectangle with the padding values, or null if no padding is required for this filter.

### `initialize`

() deprecated protected

Inherited from Filter: `initialize:74`

REMOVED. Removed in favor of using `MySuperClass_constructor`. See extend and promote for details.

There is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.

### `toString`

() String

Inherited from Filter: `toString:129`

Returns a string representation of this object.

#### Returns:

String:

a string representation of the instance.

## Properties

### `matrix`

Array | ColorMatrix

Defined in `matrix:70`

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