API

Interface Task

Polymorphic interface that all frame-graph tasks implement: records Pass objects during record() and is executed once per frame.

interface Task {
    engine: EngineContext;
    executionEnabled?: boolean;
    name: string;
    scene?: SceneContext;
    dispose(): void;
    execute?(): number;
    record(): void;
}

Hierarchy (View Summary)

Index

Engine captured at task creation.

executionEnabled?: boolean

Runtime frame-graph execution gate, default true. When false, the frame graph keeps the task recorded and its resources alive but skips every pass or built-in execute() call for that frame. This is independent from any task-specific enabled state whose disabled transition may still execute work.

name: string
scene?: SceneContext

Owning scene for scene-bound tasks. Undefined for scene-less standalone frame graphs.