PIXI.filters.OldFilmFilter

class OldFilmFilter extends PIXI.Filter

The OldFilmFilter applies a Old film effect to an object.
original filter

See:

Constructor

new PIXI.filters.OldFilmFilter(options: object | number, seed: number) → {}

Parameters:
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

OldFilmFilterOptions	static defaults Default constructor options
number	noise = 0
number	noiseSize = 0
number	scratch = 0
number	scratchDensity = 0
number	scratchWidth = 0
number	seed = 0 A see value to apply to the random noise generation
number	sepia = 0
number	vignetting = 0
number	vignettingAlpha = 0
number	vignettingBlur = 0

boolean	autoFit = true
PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
boolean	enabled If enabled is true the filter is applied, if false it will not.
boolean	legacy
PIXI.MSAA_QUALITY	multisample The samples of the filter.
number	padding
number	resolution
PIXI.State	state The WebGL state the filter requires to render.

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

defaults OldFilmFilter.ts:31

static defaults: OldFilmFilterOptions

Default constructor options

noise OldFilmFilter.ts:114

noise: number = 0

Opacity/intensity of the noise effect between 0 and 1

noiseSize OldFilmFilter.ts:128

noiseSize: number = 0

The size of the noise particles

scratch OldFilmFilter.ts:142

scratch: number = 0

How often scratches appear

scratchDensity OldFilmFilter.ts:156

scratchDensity: number = 0

The density of the number of scratches

scratchWidth OldFilmFilter.ts:170

scratchWidth: number = 0

The width of the scratches

seed OldFilmFilter.ts:44

seed: number = 0

A see value to apply to the random noise generation

sepia OldFilmFilter.ts:98

sepia: number = 0

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

vignetting OldFilmFilter.ts:184

vignetting: number = 0

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

vignettingAlpha OldFilmFilter.ts:199

vignettingAlpha: number = 0

Amount of opacity of vignette

vignettingBlur OldFilmFilter.ts:213

vignettingBlur: number = 0

Blur intensity of the vignette