BackdropFilter

class BackdropFilter extends PIXI.Filter

This filter uses a backdrop texture to calculate the output colors.

A backdrop filter can use existing colors in the destination framebuffer to calculate the output colors. It does not need to rely on in-built blend modes to do those calculations.

Constructor

new BackdropFilter() → {}

This filter uses a backdrop texture to calculate the output colors.

Summary

Properties from BackdropFilter

string

backdropUniformName = undefined

The name of the uniform for the backdrop texture.

Float32Array

clearColor = undefined

If non-null, @pixi/picture will clear the filter's output framebuffer with this RGBA color.

Properties inherited from Filter

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.

Properties inherited from Shader

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

Methods inherited from Filter

void	apply(filterManager: PIXI.FilterSystem, input: PIXI.RenderTexture, output: PIXI.RenderTexture, clearMode: PIXI.CLEAR_MODES, _currentState: object)

Public Properties

backdropUniformName BlendFilter.ts:11

backdropUniformName: string = undefined

The name of the uniform for the backdrop texture.

clearColor BlendFilter.ts:22

clearColor: Float32Array = undefined

If non-null, @pixi/picture will clear the filter's output framebuffer with this RGBA color.