Extensions

Class: BaseFilter

BaseFilter(options)

Base Filter

Constructor

new BaseFilter(options)

Creates an instance of BaseFilter.
Parameters:
Name Type Description
options object
Properties
Name Type Description
on boolean Default value true
- Turn on or off the filter
intensity number Default value 1
- Intensity of the filter
- If the intensity changes, then intensityX and intensityY also change simultaneously to the same value.
intensityX number Default value 1
- Intensity on the X coordinate
intensityY number Default value 1
- Intensity on the Y coordinate
mix number Default value 1
- Mix between the original and the filtered image (0 - original, 1 - filtered image)
isRadial number Default value false|0
- Radial fade between the original and filtered image
- The fade is measured in UV space, so on a non-square canvas the shape follows the canvas aspect (an ellipse, not a circle)
centerX number Default value 0.5
- X center of the radial fade
centerY number Default value 0.5
- Y center of the radial fade
invertRadial boolean Default value false|0
- Inverts the radial fade (filtered centre, original edges)
size number Default value 1
- Size of the radial fade
roundness number Default value 1
- Roundness of the radial fade
- 0 gives an ellipse that follows the canvas aspect, 1 approaches a rectangle
transition number Default value 1
- Transition of the radial fade
kernels number Default value Float32Array(9)
- Kernel for convolution filters
Properties:
Name Type Description
on boolean
Source:

Classes

BaseFilter

Members

centerX :number

Set/Get center x
Type:
  • number
Source:

centerY :number

Set/Get center y
Type:
  • number
Source:

intensity :number

Set/Get intensity
Type:
  • number
Source:

intensityX :number

 Set/Get intensity x
   - Same as intensity
Type:
  • number
Source:

intensityY :number

Set/Get intensity y
Type:
  • number
Source:

invertRadial :boolean

Set/Get invertRadial
Type:
  • boolean
Source:

isRadial :boolean

Set/Get is radial
Type:
  • boolean
Source:

mix :number

Set/Get mix
Type:
  • number
Source:

roundness :number

Set/Get roundness
Type:
  • number
Source:

size :number

Set/Get size
Type:
  • number
Source:

transition :number

Set/Get transition
Type:
  • number
Source: