Function: shockwaveEffect()

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

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

Shockwave the canvas element: a single radial ripple distortion travels outward from an origin point and fades (ShockwaveFilter) - a one-shot impact, not a repeated oscillation.

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

The alias to identify the component.

options?Copy Anchor Link

ShockwaveEffectProps = {}

Animation options.

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the PixiJS ticker.

ReturnsCopy Anchor Link

Promise<string[] | undefined>