# Function: desaturateEffect() (/pixi-vn/index/namespaces/effects/functions/desaturateEffect)



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

Defined in: [src/canvas/functions/canvas-effect.ts:730](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L730)

Desaturate the canvas element: color drains out to [DesaturateEffectProps.amount](/pixi-vn/index/interfaces/DesaturateEffectProps#amount) and
recovers back to normal - a single dip, not a repeated oscillation
([AdjustmentFilter](https://pixijs.io/filters/docs/AdjustmentFilter.html)).

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`DesaturateEffectProps`](/pixi-vn/index/interfaces/DesaturateEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>