PixiJS Filters

Class: OldFilmFilter

OldFilmFilter

The OldFilmFilter applies a Old film effect to an object.
originalfilter

new OldFilmFilter (options)

Name Type Attributes Description
options OldFilmFilterOptions <optional>

Options for the OldFilmFilter constructor.

Extends

  • Filter

Members

DEFAULT_OPTIONS OldFilmFilterOptions staticreadonly

Default values for options.

noise number

Opacity/intensity of the noise effect between 0 and 1

Default Value:
  • 0.3

noiseSize number

The size of the noise particles

Default Value:
  • 1

scratch number

How often scratches appear

Default Value:
  • 0.5

scratchDensity number

The density of the number of scratches

Default Value:
  • 0.3

scratchWidth number

The width of the scratches

Default Value:
  • 1

seed number

A seed value to apply to the random noise generation

Default Value:
  • 0

sepia number

The amount of saturation of sepia effect, a value of 1 is more saturation and closer to 0 is less, and a value of 0 produces no sepia effect

Default Value:
  • 0.3

vignetting number

The radius of the vignette effect, smaller values produces a smaller vignette

Default Value:
  • 0.3

vignettingAlpha number

Amount of opacity on the vignette

Default Value:
  • 1

vignettingBlur number

Blur intensity of the vignette

Default Value:
  • 1