Gaussian Blur

Gaussian Blur operator properties for Script Engine. Real-time Gaussian blur filter for video frames. Exposes radius, softness, blend strength, directional (horizontal/vertical/2D) blur, quality presets, alpha-channel handling, and an optional edge-preserving mode that softens flat regions while keeping strong edges crisp.

Property Type Access Description
ShowAdvancedOptions bool get/set Show or hide the operator's advanced settings in the editor UI. [default=false].
BlurRadius int get/set Blur radius in pixels. [min=0, max=50, default=5]. Controls how far the blur reaches: each output pixel is averaged with its neighbours up to this many pixels away in every blurred direction. 0 disables the blur (passthrough); larger values produce a softer, more diffuse result at higher processing cost. Very large values can become expensive on high-resolution frames.
BlurStrength int get/set Blur strength as a percentage. [min=0, max=100, default=100]. Linear blend factor between the original frame (0) and the fully blurred frame (100). Use intermediate values for a partial-blur "veiling" effect, or to animate the blur in and out at a fixed radius. The blur is still computed at the configured radius — this only controls how strongly it is mixed with the original image.
Direction BlurDirection get/set Blur direction. [default=Both]. Selects which axes the blur is applied along: Both runs a full 2D blur, HorizontalOnly smears the image left/right only, and VerticalOnly smears it up/down only. The single-direction modes are roughly half the cost of Both and are useful for motion-blur-style streaks or interlace-style softening.
Quality BlurQuality get/set Blur quality preset. [default=Standard]. Trades processing cost against visual quality. Fast is the cheapest and is suited for live work or high-resolution frames where headroom matters; Standard is the recommended default; High produces the smoothest, cleanest blur and is best for offline renders, archival output, or large radii where banding would otherwise be visible.
ResetBlurCmd Command get Reset all blur settings to their defaults. Invokable command. Restores BlurRadius=5, BlurStrength=100, Direction=Both, Quality=Standard, Sigma=0 (auto), BlurAlpha=false, PreserveEdges=false, and EdgeThreshold=20. Useful from scripts that want a known starting state before applying a new look, or as a one-shot recovery after experimentation.
Sigma int get/set Gaussian sigma (softness). [min=0, max=200, default=0]. The slider value is internally divided by 10, giving an effective sigma range of 0.0–20.0. 0 means "auto" — sigma is chosen automatically from BlurRadius for a clean, balanced blur. Override this to decouple softness from radius: a higher sigma at the same radius gives a flatter, softer look, while a lower sigma produces a tighter, more concentrated blur. Most users can leave this at 0 and only adjust BlurRadius.
BlurAlpha bool get/set Whether to blur the alpha channel as well as RGB. [default=false]. When false, only the colour channels are blurred and the original alpha is preserved untouched — keeping mask/key edges crisp. Set true to soften alpha along with colour, which is what you usually want for keyed sources, feathered mattes, or composited graphics where hard alpha edges would otherwise show through the blur.
PreserveEdges bool get/set Enable edge-aware blurring. [default=false]. When enabled, the blur softens flat regions of the image while keeping strong edges sharp, instead of softening everything uniformly. This preserves crisp boundaries (text, contours, eyes) while still smoothing surfaces — handy for skin smoothing or denoise-style looks. Has a noticeably higher processing cost than a plain blur. Toggling this also controls visibility of EdgeThreshold, which only takes effect while edge preservation is on.
EdgeThreshold int get/set Edge threshold for edge-preserving mode, as a percentage. [min=0, max=100, default=20]. Only used when PreserveEdges is true. Sets the maximum luminance difference (in normalised 0–1 units after division by 100) at which two pixels are still considered part of the same surface and allowed to blur together. Lower values protect more edges (sharper, less smoothing); higher values let more contrast bleed through and approach a plain Gaussian. Tune in tandem with BlurRadius — a large radius with a tight threshold gives a strong "smoothed but detailed" look.
ShowOriginal bool get/set Bypass the blur and pass the original image through unchanged. [default=false]. Diagnostic toggle. When true, the operator outputs the source frame as-is, letting you A/B-compare blurred vs. original without removing the operator from the chain or losing downstream wiring. Leave false for normal operation.
Minilog FormattedMessage get/set Most recent status/info message emitted by the operator. Read-only style status line surfaced to the UI and to scripts. The operator writes here when settings change via hotkeys (F1–F8), when ResetBlurCmd runs, and at initialization. Useful from a script to mirror operator state into another component or a dashboard.

Inherits from: AbstractOperator, AbstractAudioMetering.

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