Class FrameGraphRenderPass
Hierarchy (View Summary)
- FrameGraphPass<WebXRSpatialLayerType>
- FrameGraphRenderPass
Properties
depth
If true, the depth attachment will be read-only (may allow some optimizations in WebGPU)
disabled
Whether the pass is disabled. Disabled passes will be skipped during execution.
name
stencil
If true, the stencil attachment will be read-only (may allow some optimizations in WebGPU)
Accessors
frame
-
get frameGraphRenderTarget(): FrameGraphRenderTarget
Gets the frame graph render target used by the render pass.
Returns FrameGraphRenderTarget
render
-
get renderTarget(): any
Gets the handle(s) of the render target(s) used by the render pass.
Returns any
render
-
get renderTargetDepth(): any
Gets the handle of the render target depth used by the render pass.
Returns any
Methods
add
-
Adds dependencies to the render pass.
Parameters
Optionaldependencies: anyThe dependencies to add.
Returns void
collect
-
Collects the dependencies of the render pass.
Parameters
- dependencies: Set<FrameGraphTextureHandle>
The set of dependencies to update.
Returns void
- dependencies: Set<FrameGraphTextureHandle>
set
-
Sets the function to execute when the pass is executed
Parameters
- func: (context: FrameGraphRenderContext) => void
The function to execute when the pass is executed
Returns void
- func: (context: FrameGraphRenderContext) => void
set
-
Initializes the pass. This function is called once after the frame graph has been built
Parameters
- func: (context: FrameGraphRenderContext) => void
The function to initialize the pass.
Returns void
- func: (context: FrameGraphRenderContext) => void
set
-
Sets the output layer and face indices for multi-render target rendering.
Parameters
- indices: LayerAndFaceIndex[]
The array of layer and face indices.
Returns void
- indices: LayerAndFaceIndex[]
set
-
Sets the render target(s) to use for rendering.
Parameters
OptionalrenderTargetHandle: anyThe render target to use for rendering, or an array of render targets to use for multi render target rendering.
Returns void
set
-
Sets the render target depth to use for rendering.
Parameters
OptionalrenderTargetHandle: anyThe render target depth to use for rendering.
Returns void
StaticIs
-
Checks if a pass is a render pass.
Parameters
- pass: IFrameGraphPass
The pass to check.
Returns pass is FrameGraphRenderPass
True if the pass is a render pass, else false.
- pass: IFrameGraphPass
Render pass used to render objects.