Interface ScriptableRenderPass<P>

Stable pass object whose callbacks must all complete synchronously.

interface ScriptableRenderPass<P extends object> {
    name: string;
    execute(context: ScriptableRenderPassContext, parameters: P): unknown;
    prepare?(context: ScriptableRenderPrepareContext, parameters: P): unknown;
    setup(builder: ScriptableRenderPassBuilder, parameters: P): unknown;
}

Type Parameters

P extends object

Implemented by

Index

Properties

Methods

execute prepare? setup

Properties

`Readonly`name

name: string

Human-readable pass name used in graph diagnostics.

Methods

execute

execute(context: ScriptableRenderPassContext, parameters: P): unknown
Emit commands through the portable facade.
Parameters
- context: ScriptableRenderPassContext
- parameters: P
Returns unknown
An ignored synchronous value. Promise-like values are rejected.
- Defined in render/pipeline/ScriptableRenderGraph.ts:223

`Optional`prepare

prepare?(context: ScriptableRenderPrepareContext, parameters: P): unknown
Prepare reusable backend objects after graph resources exist and before command emission.
Parameters
- context: ScriptableRenderPrepareContext
- parameters: P
Returns unknown
An ignored synchronous value. Promise-like values are rejected.
- Defined in render/pipeline/ScriptableRenderGraph.ts:217

setup

setup(builder: ScriptableRenderPassBuilder, parameters: P): unknown
Declare all resources and dependencies without issuing GPU commands.
Parameters
- builder: ScriptableRenderPassBuilder
- parameters: P
Returns unknown
An ignored synchronous value. Promise-like values are rejected.
- Defined in render/pipeline/ScriptableRenderGraph.ts:211