VFX-JS
    Preparing search index...

    Type Alias ChainFrameInput

    type ChainFrameInput = {
        time: number;
        deltaTime: number;
        mouse: [number, number];
        mouseViewport: [number, number];
        intersection: number;
        enterTime: number;
        leaveTime: number;
        resolvedUniforms: Record<string, EffectUniformValue>;
        canvasSize: readonly [number, number];
        canvasBufferSize: readonly [number, number];
        elementSize: readonly [number, number];
        elementBufferSize: readonly [number, number];
        elementRectOnCanvasPx: { x: number; y: number; w: number; h: number };
        finalTarget: EffectRenderTarget | null;
        isVisible: boolean;
    }
    Index

    Properties

    time deltaTime mouse mouseViewport intersection enterTime leaveTime resolvedUniforms canvasSize canvasBufferSize elementSize elementBufferSize elementRectOnCanvasPx finalTarget isVisible

    Properties

    time: number
    deltaTime: number
    mouse: [number, number]
    mouseViewport: [number, number]
    intersection: number
    enterTime: number
    leaveTime: number
    resolvedUniforms: Record<string, EffectUniformValue>
    canvasSize: readonly [number, number]

    Canvas size (= viewport-inner + scrollPadding on each side), CSS px.

    canvasBufferSize: readonly [number, number]

    Canvas size, device px.

    elementSize: readonly [number, number]

    Element rect (inner, no overflow), CSS px. Mirrors canvas for post effects.

    elementBufferSize: readonly [number, number]

    Element rect (inner, no overflow), device px. Mirrors canvas for post effects.

    elementRectOnCanvasPx: { x: number; y: number; w: number; h: number }

    Element's content rect on canvas, bottom-left origin, device px.
    Used to position the final-stage draw viewport (canvas-space) and
    to derive dims.canvasRect in element-local coords (the canvas
    itself is (0, 0, canvasBufferSize) in canvas coords).

    finalTarget: EffectRenderTarget | null

    Destination for the last rendering stage. null draws to the
    canvas; otherwise the handle's underlying FBO is used (e.g. when
    a post-effect chain reads this chain's output as its input).

    isVisible: boolean

    Settings

    Member Visibility

    On This Page

    Properties