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



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

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

Pulse a vignette on the canvas element: the edges darken and recover, in a repeated, decaying
pulse - built on [CRTFilter](https://pixijs.io/filters/docs/CRTFilter.html) 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.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

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

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

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