Vignette

Video Single output Transform

Make or reverse a vignette effect.

FFmpeg filter: vignette — the official reference.

Add it to a graph. The explicit form works for every filter — bind it to its input and read the result from outputs():

$node   = $video->addFilter(new Vignette(…));
$result = $node->outputs()[0];

Shorthand. Single-output filters can skip the node — apply() returns the result stream directly:

$result = $video->apply(new Vignette(…));

When to use it

TODO — when this filter shines: what it’s the right tool for, what to reach for instead when it isn’t, and how it composes with neighbouring filters.

How to use it

TODO — prose: how the filter actually works and what its key parameters mean (the explanation FFmpeg’s terse option help omits).

Examples

TODO — runnable PHP, with the equivalent ffmpeg CLI alongside.

Gotchas

TODO

See also

TODO

Parameters

Parameter	Type	Default	Range / values	Description
angle	string	PI/5	—	set lens angle
x0	string	w/2	—	set circle center position on x-axis
y0	string	h/2	—	set circle center position on y-axis
mode	VignetteMode	forward	forward, backward	set forward/backward mode
eval	VignetteEval	init	init, frame	specify when to evaluate expressions
dither	bool	true	—	set dithering
aspect	string	—	—	set aspect ratio

FFmpeg also names these options (use the parameter shown above): a → angle.

---

Maps to FFmpeg’s vignette filter. Verified against ffmpeg n7.1.1.