Classes
Methods
activate(_bool)
Activate the filter.
Parameters:
| Name | Type | Description |
|---|---|---|
_bool | boolean | Flag to activate or not. |
- Source
addEventListener(type, callback)
Add an event listener to this class.
Parameters:
| Name | Type | Description |
|---|---|---|
type | string | The event type. |
callback | function | The function associated with the provided event type, will be called with the fired event. |
- Source
getName() → {string}
Get the name of the filter.
- Source
Returns:
The name of the filter.
- Type:
- string
getOriginalImage() → {Image}
Get the original image.
- Source
Returns:
image The original image.
- Type:
- Image
init()
Initialise the filter. Called once the image is loaded.
- Source
removeEventListener(type, callback)
Remove an event listener from this class.
Parameters:
| Name | Type | Description |
|---|---|---|
type | string | The event type. |
callback | function | The function associated with the provided event type. |
- Source
run(_args)
Run the filter.
Parameters:
| Name | Type | Description |
|---|---|---|
_args | * | The filter arguments. |
- Source
setOriginalImage(image)
Set the original image.
Parameters:
| Name | Type | Description |
|---|---|---|
image | Image | The original image. |
- Source
update() → {Image}
Transform the main image using this filter.
- Source
Returns:
The transformed image.
- Type:
- Image