Function: desaturateEffect()

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

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

Desaturate the canvas element: color drains out to DesaturateEffectProps.amount and recovers back to normal - a single dip, not a repeated oscillation (AdjustmentFilter).

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

The alias to identify the component.

options?Copy Anchor Link

DesaturateEffectProps = {}

Animation options.

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the PixiJS ticker.

ReturnsCopy Anchor Link

Promise<string[] | undefined>