@pixi/3d
    Preparing search index...

    Interface TiltShiftEffectOptions

    Constructor options for TiltShiftEffect

    const options: TiltShiftEffectOptions = { focalDepth: 20, focalNear: 2, maxBlur: 16 };
    view3d.passes = [new TiltShiftEffect(options)];
    interface TiltShiftEffectOptions {
        debug?: boolean;
        enabled?: boolean;
        focalDepth?: number;
        focalFar?: number;
        focalNear?: number;
        maxBlur?: number;
        stage?: EffectStage;
    }

    Hierarchy (View Summary)

    Index
    debug? enabled? focalDepth? focalFar? focalNear? maxBlur? stage?
    debug?: boolean

    Whether to paint the focus settings instead of blurring; TiltShiftEffect#debug has the colour key

    false

    new TiltShiftEffect({ debug: true });
    enabled?: boolean

    Whether the pass starts enabled; see Pass3D#enabled

    true

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

    Distance from the camera to the plane in focus, in world units

    The plane faces the camera, so it moves and turns with it.

    35

    new TiltShiftEffect({ focalDepth: 20 });
    focalFar?: number

    Distance from the focal plane at which the blur is strongest, in world units

    14

    new TiltShiftEffect({ focalFar: 6 });
    focalNear?: number

    How far either side of the focal plane stays fully sharp, in world units

    Keep it below focalFar.

    3

    new TiltShiftEffect({ focalNear: 1 });
    maxBlur?: number

    Blur radius at full strength, in physical pixels on screen

    12

    new TiltShiftEffect({ maxBlur: 20 });
    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