Base class that all filters should inherit from. Filters need to be applied to objects that have been cached using the cache method. If an object changes, please cache it again, or use updateCache. Note that the filters must be applied before caching.
myInstance.filters = [ new createjs.ColorFilter(0, 0, 0, 1, 255, 0, 0), new createjs.BlurFilter(5, 5, 10) ]; myInstance.cache(0,0, 100, 100);
Note that each filter can implement a getBounds method, which returns the margins that need to be applied in order to fully display the filter. For example, the BlurFilter will cause an object to feather outwards, resulting in a margin around the shape.
EaselJS FiltersEaselJS comes with a number of pre-built filters:
- AlphaMapFilter : Map a greyscale image to the alpha channel of a display object
- AlphaMaskFilter: Map an image's alpha channel to the alpha channel of a display object
- BlurFilter: Apply vertical and horizontal blur to a display object
- ColorFilter: Color transform a display object
- ColorMatrixFilter: Transform an image using a ColorMatrix
Target ImageData instance.
Applies the filter to the specified context.
The 2D context to use as the source.
The x position to use for the source rect.
The y position to use for the source rect.
The width to use for the source rect.
The height to use for the source rect.
The 2D context to draw the result to. Defaults to the context passed to ctx.
The x position to draw the result to. Defaults to the value passed to x.
The y position to draw the result to. Defaults to the value passed to y.
If the filter was applied successfully.
Returns a clone of this Filter instance.
A clone of the current Filter instance.
Provides padding values for this filter. That is, how much the filter will extend the visual bounds of an object it is applied to.
If specified, the provided Rectangle instance will be expanded by the padding amounts and returned.
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.
Assign any unique uniforms or other setup functionality here.
The context associated with the stage performing the render.
The stage instance that will be rendering.
The compiled shader that is going to be used to perform the render.
Another filter that is required to act as part of this filter and created and managed under the hood.
Pre-processed template shader code. It will be parsed before being fed in into the shader compiler. This should be based upon StageGL.SHADER_FRAGMENT_BODY_REGULAR
A flag stating that this filter uses a context draw mode and cannot be batched into imageData processing.
Pre-processed template shader code. It will be parsed before being fed in into the shader compiler. This should be based upon StageGL.SHADER_VERTEX_BODY_REGULAR