RenderPassBuilder

class in InfEngine.rendergraph

Description

Fluent builder for constructing a render pass.

description

Constructors

Signature Description
RenderPassBuilder.__init__(name: str, graph: RenderGraph | None = ...) → None

constructors

Properties

Name Type Description
name str The name of this render pass. (read-only)

properties

Public Methods

Method Description
read(texture: str | TextureHandle) → RenderPassBuilder Declare a texture as a read dependency for this pass.
write_color(texture: str | TextureHandle, slot: int = ...) → RenderPassBuilder Declare a color attachment output for this pass.
write_depth(texture: str | TextureHandle) → RenderPassBuilder Declare a depth attachment output for this pass.
set_texture(sampler_name: str, texture: str | TextureHandle) → RenderPassBuilder Bind a texture to a sampler input for this pass.
set_clear(color: Optional[Tuple[float, float, float, float]] = ..., depth: Optional[float] = ...) → RenderPassBuilder Set clear values for color and/or depth attachments.
draw_renderers(queue_range: Tuple[int, int] = ..., sort_mode: str = ..., pass_tag: str = ..., override_material: str = ...) → RenderPassBuilder Draw visible renderers filtered by queue range.
draw_skybox() → RenderPassBuilder Draw the skybox in this pass.
draw_shadow_casters(queue_range: Tuple[int, int] = ..., light_index: int = ..., shadow_type: str = ...) → RenderPassBuilder Draw shadow-casting geometry for a light.
draw_screen_ui(list: str | int = ...) → RenderPassBuilder Draw screen-space UI elements in this pass.
fullscreen_quad(shader: str) → RenderPassBuilder Draw a fullscreen quad with the specified shader.

public_methods

Operators

Method Returns
__repr__() → str str

operators

Example

# TODO: Add example for RenderPassBuilder

example

See Also

see_also