Trait maplibre::render::graph::node::Node

source ·

pub trait Node: Downcast + Send + Sync + 'static {
    // Required method
    fn run(
        &self,
        graph: &mut RenderGraphContext<'_>,
        render_context: &mut RenderContext<'_>,
        resources: &RenderResources,
        world: &World
    ) -> Result<(), NodeRunError>;

    // Provided methods
    fn input(&self) -> Vec<SlotInfo> { ... }
    fn output(&self) -> Vec<SlotInfo> { ... }
    fn update(&mut self, _state: &mut RenderResources) { ... }
}

Expand description

A render node that can be added to a RenderGraph.

Nodes are the fundamental part of the graph and used to extend its functionality, by generating draw calls and/or running subgraphs. They are added via the render_graph::add_node(my_node) method.

To determine their position in the graph and ensure that all required dependencies (inputs) are already executed, Edges are used.

A node can produce outputs used as dependencies by other nodes. Those inputs and outputs are called slots and are the default way of passing render data inside the graph. For more information see SlotType.

Required Methods§

source

fn run( &self, graph: &mut RenderGraphContext<'_>, render_context: &mut RenderContext<'_>, resources: &RenderResources, world: &World ) -> Result<(), NodeRunError>

Runs the graph node logic, issues draw calls, updates the output slots and optionally queues up subgraphs for execution. The graph data, input and output values are passed via the RenderGraphContext.