API

Interface ScreenSpaceGlobalIlluminationPostProcessTask

A screen-space global-illumination frame-graph task. Mutable fields are sampled fresh each frame.

interface ScreenSpaceGlobalIlluminationPostProcessTask {
    bias: number;
    colorBleedGain: number;
    colorBleedMax: number;
    depthTexture: RenderTarget;
    edgeFade: number;
    enabled: boolean;
    engine: EngineContext;
    executionEnabled?: boolean;
    fadeEnd: number;
    fadeStart: number;
    illuminationTexture: RenderTarget;
    intensity: number;
    name: string;
    outputTexture: RenderTarget;
    rayCount: number;
    rayLength: number;
    resetVersion: number;
    scene?: SceneContext;
    sourceTexture: RenderTarget;
    stepCount: number;
    targetTexture: RenderTarget | null;
    temporalWeight: number;
    thickness: number;
    dispose(): void;
    execute?(): number;
    record(): void;
}

Hierarchy (View Summary)

  • Task
    • ScreenSpaceGlobalIlluminationPostProcessTask
Index
bias: number
colorBleedGain: number
colorBleedMax: number
depthTexture: RenderTarget
edgeFade: number
enabled: boolean

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.

fadeEnd: number
fadeStart: number
illuminationTexture: RenderTarget

The resolved, temporally stable indirect-illumination target (rgba16float: color in .rgb, view distance in .a).

intensity: number
name: string
outputTexture: RenderTarget
rayCount: number
rayLength: number
resetVersion: number
scene?: SceneContext

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

sourceTexture: RenderTarget
stepCount: number
targetTexture: RenderTarget | null
temporalWeight: number
thickness: number