API

Interface ExtractHighlightsPostProcessTask

A post-process task that keeps only pixels whose luminance exceeds threshold and zeroes the rest.

interface ExtractHighlightsPostProcessTask {
    alphaMode: PostProcessAlphaMode;
    clear: boolean;
    engine: EngineContext;
    executionEnabled?: boolean;
    exposure: number;
    name: string;
    outputTexture: RenderTarget;
    scene?: SceneContext;
    sourceSamplingMode: PostProcessSamplingMode;
    sourceTexture: RenderTarget;
    targetTexture: RenderTarget | null;
    threshold: number;
    viewport: NormalizedViewport | null;
    dispose(): void;
    execute?(): number;
    record(): void;
    updateUniforms(): void;
}

Hierarchy (View Summary)

Index
clear: boolean

Clear the target before drawing. Set false when several viewport passes share a target.

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.

exposure: number
name: string
outputTexture: RenderTarget
scene?: SceneContext

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

sourceSamplingMode: PostProcessSamplingMode
sourceTexture: RenderTarget
targetTexture: RenderTarget | null
threshold: number
viewport: NormalizedViewport | null