@pixi/3d
    Preparing search index...

    Interface BloomEffectOptions

    Constructor options for BloomEffect

    const options: BloomEffectOptions = { threshold: 0.5, intensity: 1.2, levels: 6 };
    view3d.passes = [new BloomEffect(options)];
    interface BloomEffectOptions {
        enabled?: boolean;
        intensity?: number;
        levels?: number;
        radius?: number;
        resolution?: number;
        stage?: EffectStage;
        threshold?: number;
    }

    Hierarchy (View Summary)

    Index
    enabled?: boolean

    Whether the pass starts enabled; see Pass3D#enabled

    true
    
    view.passes = [new MeshPass({ name: 'wireframe', enabled: false })];
    
    intensity?: number

    Strength of the glow added back onto the frame

    1
    
    new BloomEffect({ intensity: 2 });
    
    levels?: number

    Number of blur levels; each is half the size of the last and doubles the glow's reach

    Rounded to a whole number, at least 1. Fixed at construction.

    5
    
    new BloomEffect({ levels: 3 });
    
    radius?: number

    How much each coarser level blends into the finer one, 0 to 1

    0 keeps only the finest level, a tight halo. 1 replaces each level with the coarser one, the widest and softest haze.

    0.6
    
    new BloomEffect({ radius: 0.9 });
    
    resolution?: number

    Texels per logical pixel for the largest blur level, like a pixi filter's resolution

    A glow has no fine detail, so a fraction is the usual choice. Fixed at construction.

    0.5
    
    new BloomEffect({ resolution: 0.25 });
    
    stage?: EffectStage

    Whether the effect reads the scene as light, before the tone curve, or the picture as it will show, after it

    Each effect class picks the right one by default, so set it only to move one instance, such as a tint meant for the light rather than the picture. See PostEffect#stage.

    'beforeToneMapping', unless the effect's class says otherwise
    
    new TintEffect({ tint: 0xffaa66, stage: 'beforeToneMapping' });
    
    threshold?: number

    Brightness above which a pixel blooms, measured on its brightest channel

    A pixel blooms with the brightness it has above the threshold, eased in from half the threshold, so the cut-off is soft. At the default stage it's measured before the tone curve, so 1 blooms mostly what is brighter than white.

    1
    
    new BloomEffect({ threshold: 0.5 });