@pixi/3d
    Preparing search index...

    Interface TintEffectOptions

    Constructor options for TintEffect

    const options: TintEffectOptions = { tint: 'skyblue', enabled: false };
    view3d.passes = [new TintEffect(options)];
    interface TintEffectOptions {
        enabled?: boolean;
        stage?: EffectStage;
        tint?: ColorSource;
    }

    Hierarchy (View Summary)

    Index
    enabled? stage? tint?
    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' });
    tint?: ColorSource

    Colour the frame is multiplied by; its alpha is ignored

    0xffffff

    new TintEffect({ tint: 0xff8888 });

    Settings
    Member Visibility

    On This Page
    Properties