Struct maplibre::render::graph::RenderGraphContext

pub struct RenderGraphContext<'a> {
    graph: &'a RenderGraph,
    node: &'a NodeState,
    inputs: &'a [SlotValue],
    outputs: &'a mut [Option<SlotValue>],
    run_sub_graphs: Vec<RunSubGraph>,
}

The context with all graph information required to run a Node. This context is created for each node by the RenderGraphRunner.

The slot input can be read from here and the outputs must be written back to the context for passing them onto the next node.

Sub graphs can be queued for running by adding a RunSubGraph command to the context. After the node has finished running the graph runner is responsible for executing the sub graphs.

Fields

graph: &'a RenderGraph

node: &'a NodeState

inputs: &'a [SlotValue]

outputs: &'a mut [Option<SlotValue>]

run_sub_graphs: Vec<RunSubGraph>

Implementations

impl<'a> RenderGraphContext<'a>

pub fn new(
    graph: &'a RenderGraph,
    node: &'a NodeState,
    inputs: &'a [SlotValue],
    outputs: &'a mut [Option<SlotValue>]
) -> Self

Creates a new render graph context for the node.

pub fn inputs(&self) -> &[SlotValue]

Returns the input slot values for the node.

pub fn input_info(&self) -> &SlotInfos

Returns the SlotInfos of the inputs.

pub fn output_info(&self) -> &SlotInfos

Returns the SlotInfos of the outputs.

pub fn get_input(
    &self,
    label: impl Into<SlotLabel>
) -> Result<&SlotValue, InputSlotError>

Retrieves the input slot value referenced by the label.

pub fn get_input_texture(
    &self,
    label: impl Into<SlotLabel>
) -> Result<&TextureView, InputSlotError>

Retrieves the input slot value referenced by the label as a TextureView.

pub fn get_input_sampler(
    &self,
    label: impl Into<SlotLabel>
) -> Result<&Sampler, InputSlotError>

Retrieves the input slot value referenced by the label as a [Sampler].

pub fn get_input_buffer(
    &self,
    label: impl Into<SlotLabel>
) -> Result<&Buffer, InputSlotError>

Retrieves the input slot value referenced by the label as a [Buffer].

pub fn set_output(
    &mut self,
    label: impl Into<SlotLabel>,
    value: impl Into<SlotValue>
) -> Result<(), OutputSlotError>

Sets the output slot value referenced by the label.

pub fn run_sub_graph(
    &mut self,
    name: impl Into<Cow<'static, str>>,
    inputs: Vec<SlotValue>
) -> Result<(), RunSubGraphError>

Queues up a sub graph for execution after the node has finished running.

pub fn finish(self) -> Vec<RunSubGraph>

Finishes the context for this Node by returning the sub graphs to run next.