Extensions

Class: ThresholdFilter

ThresholdFilter(options)

 Threshold filter
   - Replaces pixels below the luminance threshold with the low color and the others with the high color
   - The intensity is the threshold (default 0.5)
   - Works on un-premultiplied colors, the alpha is left untouched

Constructor

new ThresholdFilter(options)

Creates an instance of ThresholdFilter.
Parameters:
Name Type Description
options object
Properties
Name Type Description
intensity number Default value 0.5
- Luminance threshold
lowR number Default value 0
lowG number Default value 0
lowB number Default value 0
highR number Default value 1
highG number Default value 1
highB number Default value 1
smoothness number Default value 0
- Width of the soft transition around the threshold
Source:

Extends

Classes

ThresholdFilter

Members

centerX :number

Set/Get center x
Type:
  • number
Overrides:
Source:

centerY :number

Set/Get center y
Type:
  • number
Overrides:
Source:

highB :number

Set/Get high color blue
Type:
  • number
Source:

highG :number

Set/Get high color green
Type:
  • number
Source:

highR :number

Set/Get high color red
Type:
  • number
Source:

intensity :number

Set/Get intensity
Type:
  • number
Overrides:
Source:

intensityX :number

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

intensityY :number

Set/Get intensity y
Type:
  • number
Overrides:
Source:

invertRadial :boolean

Set/Get invertRadial
Type:
  • boolean
Overrides:
Source:

isRadial :boolean

Set/Get is radial
Type:
  • boolean
Overrides:
Source:

lowB :number

Set/Get low color blue
Type:
  • number
Source:

lowG :number

Set/Get low color green
Type:
  • number
Source:

lowR :number

Set/Get low color red
Type:
  • number
Source:

mix :number

Set/Get mix
Type:
  • number
Overrides:
Source:

roundness :number

Set/Get roundness
Type:
  • number
Overrides:
Source:

size :number

Set/Get size
Type:
  • number
Overrides:
Source:

smoothness :number

Set/Get smoothness - 0 is a hard step
Type:
  • number
Source:

transition :number

Set/Get transition
Type:
  • number
Overrides:
Source: