API Documentation for: 0.6.0
Show:

AlphaMapFilter Class

Extends Filter
Defined in: AlphaMapFilter:34
Module: EaselJS

Applies a greyscale alpha map image (or canvas) to the target, such that the alpha channel of the result will be copied from the red channel of the map, and the RGB channels will be copied from the target.

Generally, it is recommended that you use AlphaMaskFilter, because it has much better performance.

See Filter for an example of how to apply filters.

Constructor

AlphaMapFilter

(
  • alphaMap
)

Defined in AlphaMapFilter:34

Parameters:

  • alphaMap Image

    The greyscale image (or canvas) to use as the alpha value for the result. This should be exactly the same dimensions as the target.

Item Index

Properties

Methods

applyFilter

(
  • ctx
  • x
  • y
  • width
  • height
  • targetCtx
  • targetX
  • targetY
)
Boolean

Inherited from Filter but overwritten in applyFilter:75

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

() Filter

Inherited from Filter: clone:109

Returns a clone of this Filter instance.

Returns:

Filter: A clone of the current Filter instance.

getBounds

() Rectangle

Inherited from Filter: getBounds:73

Returns a rectangle with values indicating the margins required to draw the filter. 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.

initialize

() protected

Inherited from Filter: initialize:65

Initialization method.

toString

() String

Inherited from Filter: toString:99

Returns a string representation of this object.

Returns:

String: a string representation of the instance.

Properties

alphaMap

Image

Defined in alphaMap:61

The greyscale image (or canvas) to use as the alpha value for the result. This should be exactly the same dimensions as the target.