Pixi’VN
indexNamespaceseffectsFunctions

Function: swayEffect()

pixi-vn on GitHub

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

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

Sway the canvas element: a smooth, optionally combined positional and rotational drift around its current state - a gentler, slower cousin of nodEffect/wiggleEffect.

Parameters

alias

string

The alias to identify the component.

options?

SwayEffectProps = {}

Animation options.

priority?

UPDATE_PRIORITY

The priority of the PixiJS ticker.

Returns

Promise<string[] | undefined>

On this page