Function: vignettePulseEffect()

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

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

Pulse a vignette on the canvas element: the edges darken and recover, in a repeated, decaying pulse - built on CRTFilter with its scanline/noise features turned off, isolating just the vignette.

The vignette darkens the corners of the element's own bounding rectangle, so it's meant for backgrounds and other full-frame images; on a sprite with transparent corners (a character, a shape) there's little to darken and it barely shows.

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

The alias to identify the component.

options?Copy Anchor Link

VignettePulseEffectProps = {}

Animation options.

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the PixiJS ticker.

ReturnsCopy Anchor Link

Promise<string[] | undefined>