Class: OldFilmFilter

OldFilmFilter

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

new OldFilmFilter (options, seed)

Name Type Attributes Default Description
options object | number <optional>

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

options.sepia number <optional>
0.3

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

options.noise number <optional>
0.3

Opacity/intensity of the noise effect between 0 and 1

options.noiseSize number <optional>
1.0

The size of the noise particles

options.scratch number <optional>
0.5

How often scratches appear

options.scratchDensity number <optional>
0.3

The density of the number of scratches

options.scratchWidth number <optional>
1.0

The width of the scratches

options.vignetting number <optional>
0.3

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

options.vignettingAlpha number <optional>
1.0

Amount of opacity of vignette

options.vignettingBlur number <optional>
0.3

Blur intensity of the vignette

seed number <optional>
0

A see value to apply to the random noise generation

See:

Extends

  • PIXI.Filter

Members

OldFilmFilter.defaults OldFilmFilterOptions staticreadonly

Default constructor options

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

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

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