Vignette

Vignette operator properties for Script Engine. Darkens (or lightens) the edges of the layer to draw the eye toward the centre. Useful for adding a cinematic focal feel to interview or talking-head shots, framing a scene without using a hard mask, simulating an old camera/lens with edge falloff, adding mood to night or low-key scenes, or creating coloured edge tints for stylised looks. Choose between elliptical, rectangular, or diamond shapes and several blend modes.

Property	Type	Access	Description
`Intensity`	`int`	`get/set`	Strength of the vignette, percent. [min=0, max=200, default=50]. 0 disables the effect. 50-100 gives a natural, cinematic darkening. Above 100 produces a strong, stylised vignette that can crush the corners to black.
`Size`	`int`	`get/set`	Size of the clear centre, percent. [min=0, max=100, default=50]. 0 means the vignette starts right at the centre. Higher values keep more of the image untouched and push the falloff out toward the edges.
`Softness`	`int`	`get/set`	Softness of the falloff between bright centre and dark edges. [min=0, max=100, default=50]. 0 gives a hard, vignette-with-a-mask look. Higher values feather the transition for a smooth, organic falloff.
`Shape`	`VignetteShape`	`get/set`	Shape of the vignette. [default=Elliptical]. Elliptical follows the picture's aspect for a classic camera-lens vignette. Rectangular gives a softened-rectangle frame. Diamond produces a more stylised, angular frame.
`BlendMode`	`VignetteBlendMode`	`get/set`	How the vignette mixes with the image. [default=Multiply]. Multiply darkens the edges (the standard vignette). Screen lightens them. Overlay boosts contrast at the edges. Soft Light gives a subtle, gentle effect.
`ResetVignetteCmd`	`Command`	`get`	Reset all settings to their defaults (intensity 50, size 50, softness 50, elliptical, multiply, centred).
`Roundness`	`int`	`get/set`	Roundness of the vignette shape, percent. [min=0, max=100, default=0]. 0 stretches the shape to match the picture's aspect ratio (typical lens vignette). 100 forces a perfect circle/square/diamond regardless of frame shape.
`CenterX`	`int`	`get/set`	Horizontal offset of the vignette centre. [min=-100, max=100, default=0]. 0 centres horizontally. Negative values shift it left, positive shift it right. Useful when the subject isn't centred in the frame.
`CenterY`	`int`	`get/set`	Vertical offset of the vignette centre. [min=-100, max=100, default=0]. 0 centres vertically. Negative values shift it up, positive shift it down.
`ColorRed`	`int`	`get/set`	Red component of the vignette colour. [min=0, max=255, default=0]. 0 leaves the vignette pure black (standard darkening). Raise for warm coloured vignettes.
`ColorGreen`	`int`	`get/set`	Green component of the vignette colour. [min=0, max=255, default=0].
`ColorBlue`	`int`	`get/set`	Blue component of the vignette colour. [min=0, max=255, default=0]. Raise for cool, blue-tinted vignettes. Combine with red and green for any colour cast.
`ResetColorCmd`	`Command`	`get`	Reset the vignette colour back to black (a neutral darkening vignette).
`InnerBrightness`	`int`	`get/set`	Brightness boost in the clear centre, percent. [min=50, max=150, default=100]. 100 keeps the centre untouched. Below 100 dims the centre slightly. Above 100 brightens it — useful for emphasising the focal subject by lifting just the middle.
`AffectAlpha`	`bool`	`get/set`	Apply the vignette to the transparency (alpha) channel as well. [default=No]. On = the layer becomes more transparent at the edges, useful when compositing the layer over other content. Off = only the colour is darkened or tinted.
`ShowMask`	`bool`	`get/set`	Show only the vignette mask as a grayscale image (read-only, debug). Useful for visualising shape, size, softness, and centre offset while tuning settings.
`ShowOriginal`	`bool`	`get/set`	Bypass the vignette and show the original image (read-only, debug). Quick A/B comparison without disabling the operator.
`Minilog`	`FormattedMessage`	`get/set`	Most recent status message from the operator (read-only, debug).

Inherits from: AbstractOperator, AbstractAudioMetering.

See also: Vignette in Operators — user-facing introduction, screenshots, and section summaries.