Core postprocessing stack accessible via context.postprocessing. Manages the effect pipeline independently of any specific component.

Volumes and individual PostProcessingEffect components add/remove effects to this stack. The stack builds the EffectComposer pipeline when dirty.

const bloom = new BloomEffect({ intensity: 3 });
this.context.postprocessing.addEffect(bloom);
this.context.postprocessing.removeEffect(bloom);

Constructors

Properties

adaptiveResolution: boolean = false

When enabled, the device pixel ratio will be gradually reduced when FPS is low and restored when performance recovers.

false
multisampling: number | "auto" = "auto"

Set multisampling to "auto" to automatically adjust the multisampling level based on performance. Set to a number to manually set the multisampling level.

"auto"

Accessors

  • get composer(): any

    The effect composer used to render postprocessing effects. This is set internally by the PostProcessingHandler when effects are applied.

    Returns any

  • set composer(value: any): void

    Parameters

    • value: any

    Returns void

  • get dirty(): boolean

    Returns boolean

  • set dirty(value: boolean): void

    Parameters

    • value: boolean

    Returns void

  • get enabled(): boolean

    Whether the postprocessing stack runs at all. When disabled the scene is rendered directly, with no effects and no composer.

    Every effect keeps its own enabled state, so switching this back on restores exactly the stack that was there before. Useful for a quality setting, for a clean screenshot, or for comparing a scene with and without effects.

    Returns boolean

    true
    
    context.postprocessing.enabled = false;
    
  • set enabled(value: boolean): void

    Parameters

    • value: boolean

    Returns void

Methods

  • Mark the stack as dirty so the effects are rebuilt on the next update

    Returns void