API

Interface CopyToTextureTask

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

interface CopyToTextureTask {
    engine: EngineContext;
    executionEnabled?: boolean;
    lodLevel: number;
    name: string;
    outputTexture: RenderTarget;
    ownsTargetTexture: boolean;
    resolveTexture: RenderTarget | undefined;
    scene?: SceneContext;
    sourceTexture: RenderTarget;
    targetTexture: RenderTarget | undefined;
    viewport: NormalizedViewport | null | undefined;
    dispose(): void;
    execute?(): number;
    record(): void;
}

Hierarchy (View Summary)

  • Task
    • CopyToTextureTask
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.

lodLevel: number
name: string
outputTexture: RenderTarget

resolveTexture if set, otherwise targetTexture. Kept for API parity with BJS FrameGraphCopyToTextureTask.outputTexture.

ownsTargetTexture: boolean
resolveTexture: RenderTarget | undefined
scene?: SceneContext

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

sourceTexture: RenderTarget
targetTexture: RenderTarget | undefined
viewport: NormalizedViewport | null | undefined