Taos API Reference
    Preparing search index...

    Interface RenderGraphViz

    interface RenderGraphViz {
        overlay: HTMLDivElement;
        open: () => void;
        close: () => void;
        isOpen: () => boolean;
        setGraph: (graph: RenderGraph, compiled?: CompiledGraph) => void;
        setPasses: (passes: PassNodeData[]) => void;
        setFullGraph: (data: FullGraphData) => void;
        attach: (opts?: RenderGraphAttachOptions) => RenderGraphViz;
    }
    Index

    Properties

    overlay open close isOpen setGraph setPasses setFullGraph attach

    Properties

    overlay: HTMLDivElement
    open: () => void
    close: () => void
    isOpen: () => boolean
    setGraph: (graph: RenderGraph, compiled?: CompiledGraph) => void

    Capture the structure of graph (and optionally compiled, used to mark culled passes) and render it inside the overlay. Safe to call every frame — the data is only rebuilt when the overlay is open or the next time it is.

    setPasses: (passes: PassNodeData[]) => void
    setFullGraph: (data: FullGraphData) => void
    attach: (opts?: RenderGraphAttachOptions) => RenderGraphViz

    One-call wiring: installs the toggle hotkey and (unless button: false) a floating toggle button. Returns the viz unchanged so the call can be chained.

    Settings

    Member Visibility

    On This Page

    Properties