Extensions

Class: FilmGrainFilter

FilmGrainFilter(options)

 Film grain filter
   - Adds animated noise to the image
   - The intensity is the grain amount (default 0.1)

Constructor

new FilmGrainFilter(options)

Creates an instance of FilmGrainFilter.
Parameters:
Name Type Description
options object
Properties
Name Type Description
intensity number Default value 0.1
- Grain amount
seed number Default value 1
- Noise seed
fps number Default value 24
- Grain updates per second, 0 is a static grain independent of the render time
grainSize number Default value 1
- Grain cell size in pixels
Source:

Extends

Classes

FilmGrainFilter

Members

centerX :number

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

centerY :number

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

fps :number

Set/Get grain updates per second - 0 is a static grain
Type:
  • number
Source:

grainSize :number

Set/Get grain cell size in pixels
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:

mix :number

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

roundness :number

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

seed :number

Set/Get noise seed
Type:
  • number
Source:

size :number

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

transition :number

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