Class FrameGraphTaskAbstract

constructor

• new FrameGraphTask(name: string, frameGraph: FrameGraph): FrameGraphTask

  Constructs a new frame graph task.

  Parameters

  • name: string

    The name of the task.

  • frameGraph: FrameGraph

    The frame graph this task is associated with.

  Returns FrameGraphTask

Optionaldependencies

onAfterTaskExecute

onBeforeTaskExecute

onTexturesAllocatedObservable

disabled

• get disabled(): boolean

  Whether the task is disabled.

  Returns boolean

• set disabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

name

• get name(): string

  The name of the task.

  Returns string

• set name(value: string): void

  Parameters

  • value: string

  Returns void

passes

• get passes(): IFrameGraphPass[]

  Gets the passes of the task.

  Returns IFrameGraphPass[]

passesDisabled

• get passesDisabled(): IFrameGraphPass[]

  Gets the disabled passes of the task.

  Returns IFrameGraphPass[]

dispose

• dispose(): void

  Disposes of the task.

  Returns void

getClassName

• getClassName(): string

  Gets the current class name

  Returns string

  the class name

initAsync

• initAsync(): Promise<unknown>

  This function is called once after the task has been added to the frame graph and before the frame graph is built for the first time. This allows you to initialize asynchronous resources, which is not possible in the constructor.

  Returns Promise<unknown>

  A promise that resolves when the initialization is complete.

isReady

• isReady(): boolean

  Checks if the task is ready to be executed.

  Returns boolean

  True if the task is ready to be executed, else false.

Abstractrecord

• record(skipCreationOfDisabledPasses?: boolean): void

  Records the task in the frame graph. Use this function to add content (render passes, ...) to the task.

  Parameters

  • OptionalskipCreationOfDisabledPasses: boolean

    If true, the disabled passe(s) won't be created.

  Returns void