FullScreenEffect

class in Infernux.renderstack

Inherits from: RenderPass

Description

Base class for fullscreen post-processing effects.

description

Constructors

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

constructors

Properties

Name Type Description
requires Set[str] (read-only)
modifies Set[str] (read-only)
menu_path str (read-only)

properties

Public Methods

Method Description
setup_passes(graph: RenderGraph, bus: ResourceBus) → None Override to add fullscreen passes to the render graph.
get_shader_list() → List[str] Return shader paths required by this effect.
inject(graph: RenderGraph, bus: ResourceBus) → None Inject this effect into the render graph.
get_params_dict() → Dict[str, Any] Get serializable parameters as a dictionary.
set_params_dict(params: Dict[str, Any]) → None Restore parameters from a dictionary.
apply_single_source_effect(graph: RenderGraph, bus: ResourceBus, output_name: str, pass_name: str, shader_name: str, format: Any, params: Mapping[str, object] | None = ...) → bool Apply a one-pass fullscreen effect that rewrites the scene color.

public_methods

Static Methods

Method Description
static FullScreenEffect.get_or_create_texture(graph: RenderGraph, name: str, format: Any = ..., camera_target: bool = ..., size: Any = ..., size_divisor: int = ...) → Any Get or create a named texture handle in the render graph.

static_methods

Operators

Method Returns
__repr__() → str str

operators

Example

example

# TODO: Add example for FullScreenEffect

See Also

see_also