PIXI.filters.CRTFilter

class CRTFilter extends PIXI.Filter

The CRTFilter applies a CRT effect to an object.
original filter

See:

Constructor

new PIXI.filters.CRTFilter(options: object) → {}

Parameters:
Name	Type	Attributes	Default	Description
options	object	<optional>		The optional parameters of CRT effect
options.curvature	number	<optional>	1.0	Bent of interlaced lines, higher value means more bend
options.lineWidth	number	<optional>	1.0	Width of the interlaced lines
options.lineContrast	number	<optional>	0.25	Contrast of interlaced lines
options.verticalLine	number	<optional>	false	`true` is vertical lines, `false` is horizontal
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.seed	number	<optional>	0	A seed value to apply to the random noise generation
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
options.time	number	<optional>	0	For animating interlaced lines

CRTFilterOptions	static defaults Default constructor options
number	curvature = 1
number	lineContrast = 0.25
number	lineWidth = 1
number	noise = 0
number	noiseSize = 0
number	seed = 0 A seed value to apply to the random noise generation
number	time = 0 For animating interlaced lines
boolean	verticalLine = false
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 CRTFilter.ts:34

static defaults: CRTFilterOptions

Default constructor options

curvature CRTFilter.ts:95

curvature: number = 1

Bent of interlaced lines, higher value means more bend

lineContrast CRTFilter.ts:121

lineContrast: number = 0.25

Contrast of interlaced lines

lineWidth CRTFilter.ts:108

lineWidth: number = 1

Width of interlaced lines

noise CRTFilter.ts:147

noise: number = 0

Opacity/intensity of the noise effect between 0 and 1

noiseSize CRTFilter.ts:160

noiseSize: number = 0

The size of the noise particles

seed CRTFilter.ts:52

seed: number = 0

A seed value to apply to the random noise generation

time CRTFilter.ts:49

time: number = 0

For animating interlaced lines

verticalLine CRTFilter.ts:134

verticalLine: boolean = false

true for vertical lines, false for horizontal lines

vignetting CRTFilter.ts:173

vignetting: number = 0

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

vignettingAlpha CRTFilter.ts:187

vignettingAlpha: number = 0

Amount of opacity of vignette

vignettingBlur CRTFilter.ts:200

vignettingBlur: number = 0

Blur intensity of the vignette