API
Babylon Lite API|
EffectRenderTask

Interface EffectRenderTask

A frame-graph task that renders an EffectWrapper as a fullscreen pass into an offscreen RenderTarget.

interface EffectRenderTask {
    engine: EngineContext;
    executionEnabled?: boolean;
    name: string;
    scene?: SceneContext;
    scissor?: NormalizedViewport | null;
    dispose(): void;
    execute?(): number;
    record(): void;
}

Hierarchy (View Summary)

  • Task
    • EffectRenderTask
Index
engine executionEnabled? name scene? scissor?
dispose execute? record
engine: EngineContext

Engine captured at task creation.

executionEnabled?: boolean

Runtime frame-graph execution gate; undefined means enabled. 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.

scissor?: NormalizedViewport | null

Optional draw region, normalized to the target (origin bottom-left, like a camera viewport). When set, the fullscreen pass only rasterizes this rectangle (a scissor; the target is still cleared whole when clear is on); an empty rectangle draws nothing. null/absent draws the whole target. Plain data: update it any frame.