API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceBloomFilterOptions

@codexo/exojs / rendering / stable

Construction-time options for a BloomFilter.

5
props
0
methods
0
events
Import
import { BloomFilterOptions } from '@codexo/exojs'

Construction-time options for a BloomFilter.

Properties5
intensity?: number
How much of the extracted highlight is added back. 0 leaves the input untouched, 1 adds the full excess over the threshold, higher values push a brighter glow. Default 1.
levels?: number
Halvings between the input and the level the blur runs on, 1..5. A cost knob rather than a shape knob: the same strength covers the same distance at every setting, and raising it buys that distance at a quarter of the fill rate per level. What it does change is the base of the glow, which gets softer and coarser as the blur runs on fewer texels. A node too small to take every halving takes as many as it can. Default 3.
quality?: number
Tap cap for the blur, see BlurFilterOptions.quality. Derived when omitted.
strength?: number
Gaussian standard deviation of the glow in LOGICAL units - the same quantity BlurFilterOptions.strength takes, unchanged by the display's pixel ratio. Default 8.
threshold?: number
Luminance a pixel needs before it glows, in 0..1. Rec. 709 luma of the premultiplied input, so a half-transparent white glows like an opaque grey. The knee is soft, which puts this value in the MIDDLE of the transition rather than at a hard cut: light a little below it still contributes a little glow, and a gradient crossing it shows no edge. Default 0.8.
Source
src/rendering/filters/BloomFilter.ts