#

API Documentation for: NEXT
Show: Inherited Protected Private Deprecated

# BlurFilter Class

Extends Filter
Defined in: `BlurFilter:39`
Module: EaselJS

Applies a box blur to DisplayObjects. Note that this filter is fairly CPU intensive, particularly if the quality is set higher than 1.

#### Example

This example creates a red circle, and then applies a 5 pixel blur to it. It uses the getBounds method to account for the spread that the blur causes.

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

     var blurFilter = new createjs.BlurFilter(5, 5, 1);
     shape.filters = [blurFilter];
     var bounds = blurFilter.getBounds();

     shape.cache(-50+bounds.x, -50+bounds.y, 100+bounds.width, 100+bounds.height);

See Filter for an more information on applying filters.

## Constructor

### `BlurFilter`

(

- `[blurX=0]`
- `[blurY=0]`
- `[quality=1]`

)

Defined in `BlurFilter:39`

#### Parameters:

- `[blurX=0]` Number optional

  The horizontal blur radius in pixels.

- `[blurY=0]` Number optional

  The vertical blur radius in pixels.

- `[quality=1]` Number optional

  The number of blur iterations.

- Index
- Methods
- Properties

## Item Index

### Methods

- applyFilter
- clone
- getBounds
- initialize
- toString

### Properties

- blurX
- blurY
- quality

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

() BlurFilter

Inherited from Filter but overwritten in `clone:340`

Returns a clone of this object.

#### Returns:

BlurFilter:

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

() protected

Inherited from Filter: `initialize:75`

Initialization method.

### `toString`

() String

Inherited from Filter: `toString:109`

Returns a string representation of this object.

#### Returns:

String:

a string representation of the instance.

## Properties

### `blurX`

Number

Defined in `blurX:82`

Horizontal blur radius in pixels

Default: 0

### `blurY`

Number

Defined in `blurY:90`

Vertical blur radius in pixels

Default: 0

### `quality`

Number

Defined in `quality:98`

Number of blur iterations. For example, a value of 1 will produce a rough blur. A value of 2 will produce a smoother blur, but take twice as long to run.

Default: 1