Pixi’VN
indexNamespaceseffectsFunctions

Function: glitchEffect()

pixi-vn on GitHub

> glitchEffect(alias, options?, priority?): Promise<string[] | undefined>

Defined in: src/canvas/functions/canvas-effect.ts:463

Glitch the canvas element: decaying, jittery bursts of digital-corruption slice displacement (GlitchFilter) - each burst snaps, kicks back the other way and settles - with a matching red/blue channel split layered on top (RGBSplitFilter, see GlitchEffectProps.rgbSplit). Both filters are removed once done. Returns one ticker id per filter.

Known cosmetic quirk: GlitchFilter's own destroy() (called once this effect completes, to clean up its displacement texture) can log a harmless PixiJS Warning: [BindGroup] a 'textureSource'/'textureSampler' was destroyed while still bound to a shader in the console - this comes from pixi-filters' own implementation, not from this effect, doesn't affect the component's rendering or state, and every property is still correctly restored/detached.

Parameters

alias

string

The alias to identify the component.

options?

GlitchEffectProps = {}

Animation options.

priority?

UPDATE_PRIORITY

The priority of the PixiJS ticker.

Returns

Promise<string[] | undefined>

On this page