RenderPass

class in InfEngine.renderstack

Description

Base class for custom render passes injected into the render stack.

description

Constructors

Signature Description
RenderPass.__init__(enabled: bool = ...) → None

constructors

Properties

Name Type Description
name str The unique name of this render pass. (read-only)
injection_point str The injection point where this pass is inserted. (read-only)
default_order int Default execution order within the injection point. (read-only)
requires ClassVar[Set[str]] Resource names this pass reads from. (read-only)
modifies ClassVar[Set[str]] Resource names this pass writes to. (read-only)
creates ClassVar[Set[str]] Resource names this pass creates. (read-only)
enabled bool Whether this pass is currently enabled. (read-only)

properties

Public Methods

Method Description
inject(graph: RenderGraph, bus: ResourceBus) → None Inject render commands into the graph using the resource bus.
validate(available_resources: Set[str]) → List[str] Validate that all required resources are available.

public_methods

Operators

Method Returns
__repr__() → str str

operators

Example

# TODO: Add example for RenderPass

example

See Also

see_also