@pixi/3d
    Preparing search index...

    Interface PostEffectOptions

    Constructor options shared by every PostEffect

    interface MyVignetteEffectOptions extends PostEffectOptions {
      strength?: number;
    }
    interface PostEffectOptions {
        enabled?: boolean;
        stage?: EffectStage;
    }

    Hierarchy (View Summary)

    Index
    enabled? stage?
    enabled?: boolean

    Whether the pass starts enabled; see Pass3D#enabled

    true

    view.passes = [new MeshPass({ name: 'wireframe', enabled: false })];
    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' });

    Settings
    Member Visibility

    On This Page
    Properties