Enum Edge

pub enum Edge {
    SlotEdge {
        input_node: InternedRenderLabel,
        input_index: usize,
        output_node: InternedRenderLabel,
        output_index: usize,
    },
    NodeEdge {
        input_node: InternedRenderLabel,
        output_node: InternedRenderLabel,
    },
}

An edge, which connects two Nodes in a RenderGraph.

They are used to describe the ordering (which node has to run first) and may be of two kinds: NodeEdge and SlotEdge.

Edges are added via the RenderGraph::add_node_edge and the RenderGraph::add_slot_edge methods.

The former simply states that the output_node has to be run before the input_node, while the later connects an output slot of the output_node with an input slot of the input_node to pass additional data along. For more information see SlotType.

Variants

SlotEdge

An edge describing to ordering of both nodes (output_node before input_node) and connecting the output slot at the output_index of the output_node with the slot at the input_index of the input_node.

Fields

input_node: InternedRenderLabel

input_index: usize

output_node: InternedRenderLabel

output_index: usize

NodeEdge

An edge describing to ordering of both nodes (output_node before input_node).

Fields

input_node: InternedRenderLabel

output_node: InternedRenderLabel

Implementations

impl Edge

pub fn get_input_node(&self) -> InternedRenderLabel

Returns the id of the input_node.

pub fn get_output_node(&self) -> InternedRenderLabel

Returns the id of the output_node.

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Edge

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Edge

fn eq(&self, other: &Edge) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Edge

impl StructuralPartialEq for Edge