API

Interface ClearTextureTask

Clear selected color, depth, and stencil aspects in place. Input targets are borrowed.

interface ClearTextureTask {
    clearColor: boolean;
    clearDepth: boolean;
    clearStencil: boolean;
    color: GPUColorDict;
    convertColorToLinearSpace: boolean;
    depthTexture: RenderTarget | undefined;
    engine: EngineContext;
    executionEnabled?: boolean;
    name: string;
    outputDepthTexture: RenderTarget | undefined;
    outputTexture: RenderTarget | undefined;
    scene?: SceneContext;
    stencilValue: number;
    targetTexture: RenderTarget | RenderTarget[] | undefined;
    dispose(): void;
    execute?(): number;
    record(): void;
}

Hierarchy (View Summary)

  • Task
    • ClearTextureTask
Index
clearColor: boolean
clearDepth: boolean
clearStencil: boolean
color: GPUColorDict
convertColorToLinearSpace: boolean
depthTexture: RenderTarget | undefined

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
outputDepthTexture: RenderTarget | undefined
outputTexture: RenderTarget | undefined

First color target, or undefined for a depth-only clear.

scene?: SceneContext

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

stencilValue: number
targetTexture: RenderTarget | RenderTarget[] | undefined