PixiJS Filters

Class: OldFilmFilter

PIXI.filters~OldFilmFilter

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

new OldFilmFilter (options, seed)

OldFilmFilter.js:32
Name Type Default Description
options object | number optional

The optional parameters of old film effect. When options is a number , it will be seed

Name Type Default Description
sepia number 0.3 optional

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
noise number 0.3 optional

Opacity/intensity of the noise effect between 0 and 1
noiseSize number 1.0 optional

The size of the noise particles
scratch number 0.5 optional

How often scratches appear
scratchDensity number 0.3 optional

The density of the number of scratches
scratchWidth number 1.0 optional

The width of the scratches
vignetting number 0.3 optional

The radius of the vignette effect, smaller values produces a smaller vignette
vignettingAlpha number 1.0 optional

Amount of opacity of vignette
vignettingBlur number 0.3 optional

Blur intensity of the vignette
seed number 0 optional

A see value to apply to the random noise generation
See:

Extends

  • PIXI.Filter

Members

noise number

Opacity/intensity of the noise effect between 0 and 1

Default Value:
  • 0

noiseSize number

The size of the noise particles

Default Value:
  • 0

scratch number

How often scratches appear

Default Value:
  • 0

scratchDensity number

The density of the number of scratches

Default Value:
  • 0

scratchWidth number

The width of the scratches

Default Value:
  • 0

seed number

A see value to apply to the random noise generation

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

vignetting number

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

Default Value:
  • 0

vignettingAlpha number

Amount of opacity of vignette

Default Value:
  • 0

vignettingBlur number

Blur intensity of the vignette

Default Value:
  • 0