Pixi’VN
indexFunctions

Function: createFilterTransitionApplier()

pixi-vn on GitHub

> createFilterTransitionApplier(alias, config): object

Defined in: src/canvas/functions/canvas-filter-transition-utility.ts:280

Builds the apply/cleanup pair that drives a mask-based transition (wipe/iris/split) on the component registered under alias, from nothing but plain, serializable data. It's the single place both the live transition and a ticker reconstructed after a save/restore (or a step back) get their callbacks from - which is what lets the animation resume instead of being lost. The mask Graphics is lazily recreated on the first apply() call, so a restored ticker needs nothing else.

Parameters

alias

string

config

FilterTransitionConfig

Returns

object

apply()

> apply(value): void

Parameters

value

number

Returns

void

cleanup()

> cleanup(): void

Returns

void

On this page