Skip to content

ShockwaveOptions

Defined in: effects/src/shockwave.ts:14

Options for the shockwave preset.

optional amplitude?: number

Defined in: effects/src/shockwave.ts:18

Ripple amplitude in pixels of the filter target’s local space. Default: 30.


optional brightness?: number

Defined in: effects/src/shockwave.ts:22

Ripple brightness multiplier. Unitless. Default: 1.


optional direction?: ShockwaveDirection

Defined in: effects/src/shockwave.ts:32

Ring travel. "out" expands from the trigger point. "in" starts speed × duration pixels away and contracts onto it. Default: "out".


optional duration?: number

Defined in: effects/src/shockwave.ts:34

Auto-trigger duration in seconds — ramp time between 0 and duration then idle. Default: 1.


optional radius?: number

Defined in: effects/src/shockwave.ts:27

Maximum radius in pixels of the filter target’s local space. -1 (default) keeps the ring expanding forever (no max-radius fade).


optional speed?: number

Defined in: effects/src/shockwave.ts:16

Ripple speed in pixels/second of the filter target’s local space. Default: 500.


optional wavelength?: number

Defined in: effects/src/shockwave.ts:20

Ripple wavelength in pixels of the filter target’s local space. Default: 160.

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/effects.md.