mirror of
https://github.com/bevyengine/bevy
synced 2024-12-22 19:13:08 +00:00
daa57fe489
# Objective `add_node_edge` and `add_slot_edge` are fallible methods, but are always used with `.unwrap()`. `input_node` is often unwrapped as well. This points to having an infallible behaviour as default, with an alternative fallible variant if needed. Improves readability and ergonomics. ## Solution - Change `add_node_edge` and `add_slot_edge` to panic on error. - Change `input_node` to panic on `None`. - Add `try_add_node_edge` and `try_add_slot_edge` in case fallible methods are needed. - Add `get_input_node` to still be able to get an `Option`. --- ## Changelog ### Added - `try_add_node_edge` - `try_add_slot_edge` - `get_input_node` ### Changed - `add_node_edge` is now infallible (panics on error) - `add_slot_edge` is now infallible (panics on error) - `input_node` now panics on `None` ## Migration Guide Remove `.unwrap()` from `add_node_edge` and `add_slot_edge`. For cases where the error was handled, use `try_add_node_edge` and `try_add_slot_edge` instead. Remove `.unwrap()` from `input_node`. For cases where the option was handled, use `get_input_node` instead. Co-authored-by: Torstein Grindvik <52322338+torsteingrindvik@users.noreply.github.com>
806 lines
27 KiB
Rust
806 lines
27 KiB
Rust
use crate::{
|
|
render_graph::{
|
|
Edge, Node, NodeId, NodeLabel, NodeRunError, NodeState, RenderGraphContext,
|
|
RenderGraphError, SlotInfo, SlotLabel,
|
|
},
|
|
renderer::RenderContext,
|
|
};
|
|
use bevy_ecs::{prelude::World, system::Resource};
|
|
use bevy_utils::HashMap;
|
|
use std::{borrow::Cow, fmt::Debug};
|
|
|
|
use super::EdgeExistence;
|
|
|
|
/// The render graph configures the modular, parallel and re-usable render logic.
|
|
/// It is a retained and stateless (nodes themselves may have their own internal state) structure,
|
|
/// which can not be modified while it is executed by the graph runner.
|
|
///
|
|
/// The `RenderGraphRunner` is responsible for executing the entire graph each frame.
|
|
///
|
|
/// It consists of three main components: [`Nodes`](Node), [`Edges`](Edge)
|
|
/// and [`Slots`](super::SlotType).
|
|
///
|
|
/// Nodes are responsible for generating draw calls and operating on input and output slots.
|
|
/// Edges specify the order of execution for nodes and connect input and output slots together.
|
|
/// Slots describe the render resources created or used by the nodes.
|
|
///
|
|
/// Additionally a render graph can contain multiple sub graphs, which are run by the
|
|
/// corresponding nodes. Every render graph can have its own optional input node.
|
|
///
|
|
/// ## Example
|
|
/// Here is a simple render graph example with two nodes connected by a node edge.
|
|
/// ```
|
|
/// # use bevy_app::prelude::*;
|
|
/// # use bevy_ecs::prelude::World;
|
|
/// # use bevy_render::render_graph::{RenderGraph, Node, RenderGraphContext, NodeRunError};
|
|
/// # use bevy_render::renderer::RenderContext;
|
|
/// #
|
|
/// # struct MyNode;
|
|
/// #
|
|
/// # impl Node for MyNode {
|
|
/// # fn run(&self, graph: &mut RenderGraphContext, render_context: &mut RenderContext, world: &World) -> Result<(), NodeRunError> {
|
|
/// # unimplemented!()
|
|
/// # }
|
|
/// # }
|
|
/// #
|
|
/// let mut graph = RenderGraph::default();
|
|
/// graph.add_node("input_node", MyNode);
|
|
/// graph.add_node("output_node", MyNode);
|
|
/// graph.add_node_edge("output_node", "input_node");
|
|
/// ```
|
|
#[derive(Resource, Default)]
|
|
pub struct RenderGraph {
|
|
nodes: HashMap<NodeId, NodeState>,
|
|
node_names: HashMap<Cow<'static, str>, NodeId>,
|
|
sub_graphs: HashMap<Cow<'static, str>, RenderGraph>,
|
|
input_node: Option<NodeId>,
|
|
}
|
|
|
|
impl RenderGraph {
|
|
/// The name of the [`GraphInputNode`] of this graph. Used to connect other nodes to it.
|
|
pub const INPUT_NODE_NAME: &'static str = "GraphInputNode";
|
|
|
|
/// Updates all nodes and sub graphs of the render graph. Should be called before executing it.
|
|
pub fn update(&mut self, world: &mut World) {
|
|
for node in self.nodes.values_mut() {
|
|
node.node.update(world);
|
|
}
|
|
|
|
for sub_graph in self.sub_graphs.values_mut() {
|
|
sub_graph.update(world);
|
|
}
|
|
}
|
|
|
|
/// Creates an [`GraphInputNode`] with the specified slots if not already present.
|
|
pub fn set_input(&mut self, inputs: Vec<SlotInfo>) -> NodeId {
|
|
assert!(self.input_node.is_none(), "Graph already has an input node");
|
|
|
|
let id = self.add_node("GraphInputNode", GraphInputNode { inputs });
|
|
self.input_node = Some(id);
|
|
id
|
|
}
|
|
|
|
/// Returns the [`NodeState`] of the input node of this graph.
|
|
///
|
|
/// # See also
|
|
///
|
|
/// - [`input_node`](Self::input_node) for an unchecked version.
|
|
#[inline]
|
|
pub fn get_input_node(&self) -> Option<&NodeState> {
|
|
self.input_node.and_then(|id| self.get_node_state(id).ok())
|
|
}
|
|
|
|
/// Returns the [`NodeState`] of the input node of this graph.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if there is no input node set.
|
|
///
|
|
/// # See also
|
|
///
|
|
/// - [`get_input_node`](Self::get_input_node) for a version which returns an [`Option`] instead.
|
|
#[inline]
|
|
pub fn input_node(&self) -> &NodeState {
|
|
self.get_input_node().unwrap()
|
|
}
|
|
|
|
/// Adds the `node` with the `name` to the graph.
|
|
/// If the name is already present replaces it instead.
|
|
pub fn add_node<T>(&mut self, name: impl Into<Cow<'static, str>>, node: T) -> NodeId
|
|
where
|
|
T: Node,
|
|
{
|
|
let id = NodeId::new();
|
|
let name = name.into();
|
|
let mut node_state = NodeState::new(id, node);
|
|
node_state.name = Some(name.clone());
|
|
self.nodes.insert(id, node_state);
|
|
self.node_names.insert(name, id);
|
|
id
|
|
}
|
|
|
|
/// Removes the `node` with the `name` from the graph.
|
|
/// If the name is does not exist, nothing happens.
|
|
pub fn remove_node(
|
|
&mut self,
|
|
name: impl Into<Cow<'static, str>>,
|
|
) -> Result<(), RenderGraphError> {
|
|
let name = name.into();
|
|
if let Some(id) = self.node_names.remove(&name) {
|
|
if let Some(node_state) = self.nodes.remove(&id) {
|
|
// Remove all edges from other nodes to this one. Note that as we're removing this
|
|
// node, we don't need to remove its input edges
|
|
for input_edge in node_state.edges.input_edges().iter() {
|
|
match input_edge {
|
|
Edge::SlotEdge { output_node, .. }
|
|
| Edge::NodeEdge {
|
|
input_node: _,
|
|
output_node,
|
|
} => {
|
|
if let Ok(output_node) = self.get_node_state_mut(*output_node) {
|
|
output_node.edges.remove_output_edge(input_edge.clone())?;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// Remove all edges from this node to other nodes. Note that as we're removing this
|
|
// node, we don't need to remove its output edges
|
|
for output_edge in node_state.edges.output_edges().iter() {
|
|
match output_edge {
|
|
Edge::SlotEdge {
|
|
output_node: _,
|
|
output_index: _,
|
|
input_node,
|
|
input_index: _,
|
|
}
|
|
| Edge::NodeEdge {
|
|
output_node: _,
|
|
input_node,
|
|
} => {
|
|
if let Ok(input_node) = self.get_node_state_mut(*input_node) {
|
|
input_node.edges.remove_input_edge(output_edge.clone())?;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Retrieves the [`NodeState`] referenced by the `label`.
|
|
pub fn get_node_state(
|
|
&self,
|
|
label: impl Into<NodeLabel>,
|
|
) -> Result<&NodeState, RenderGraphError> {
|
|
let label = label.into();
|
|
let node_id = self.get_node_id(&label)?;
|
|
self.nodes
|
|
.get(&node_id)
|
|
.ok_or(RenderGraphError::InvalidNode(label))
|
|
}
|
|
|
|
/// Retrieves the [`NodeState`] referenced by the `label` mutably.
|
|
pub fn get_node_state_mut(
|
|
&mut self,
|
|
label: impl Into<NodeLabel>,
|
|
) -> Result<&mut NodeState, RenderGraphError> {
|
|
let label = label.into();
|
|
let node_id = self.get_node_id(&label)?;
|
|
self.nodes
|
|
.get_mut(&node_id)
|
|
.ok_or(RenderGraphError::InvalidNode(label))
|
|
}
|
|
|
|
/// Retrieves the [`NodeId`] referenced by the `label`.
|
|
pub fn get_node_id(&self, label: impl Into<NodeLabel>) -> Result<NodeId, RenderGraphError> {
|
|
let label = label.into();
|
|
match label {
|
|
NodeLabel::Id(id) => Ok(id),
|
|
NodeLabel::Name(ref name) => self
|
|
.node_names
|
|
.get(name)
|
|
.cloned()
|
|
.ok_or(RenderGraphError::InvalidNode(label)),
|
|
}
|
|
}
|
|
|
|
/// Retrieves the [`Node`] referenced by the `label`.
|
|
pub fn get_node<T>(&self, label: impl Into<NodeLabel>) -> Result<&T, RenderGraphError>
|
|
where
|
|
T: Node,
|
|
{
|
|
self.get_node_state(label).and_then(|n| n.node())
|
|
}
|
|
|
|
/// Retrieves the [`Node`] referenced by the `label` mutably.
|
|
pub fn get_node_mut<T>(
|
|
&mut self,
|
|
label: impl Into<NodeLabel>,
|
|
) -> Result<&mut T, RenderGraphError>
|
|
where
|
|
T: Node,
|
|
{
|
|
self.get_node_state_mut(label).and_then(|n| n.node_mut())
|
|
}
|
|
|
|
/// Adds the [`Edge::SlotEdge`] to the graph. This guarantees that the `output_node`
|
|
/// is run before the `input_node` and also connects the `output_slot` to the `input_slot`.
|
|
///
|
|
/// Fails if any invalid [`NodeLabel`]s or [`SlotLabel`]s are given.
|
|
///
|
|
/// # See also
|
|
///
|
|
/// - [`add_slot_edge`](Self::add_slot_edge) for an infallible version.
|
|
pub fn try_add_slot_edge(
|
|
&mut self,
|
|
output_node: impl Into<NodeLabel>,
|
|
output_slot: impl Into<SlotLabel>,
|
|
input_node: impl Into<NodeLabel>,
|
|
input_slot: impl Into<SlotLabel>,
|
|
) -> Result<(), RenderGraphError> {
|
|
let output_slot = output_slot.into();
|
|
let input_slot = input_slot.into();
|
|
let output_node_id = self.get_node_id(output_node)?;
|
|
let input_node_id = self.get_node_id(input_node)?;
|
|
|
|
let output_index = self
|
|
.get_node_state(output_node_id)?
|
|
.output_slots
|
|
.get_slot_index(output_slot.clone())
|
|
.ok_or(RenderGraphError::InvalidOutputNodeSlot(output_slot))?;
|
|
let input_index = self
|
|
.get_node_state(input_node_id)?
|
|
.input_slots
|
|
.get_slot_index(input_slot.clone())
|
|
.ok_or(RenderGraphError::InvalidInputNodeSlot(input_slot))?;
|
|
|
|
let edge = Edge::SlotEdge {
|
|
output_node: output_node_id,
|
|
output_index,
|
|
input_node: input_node_id,
|
|
input_index,
|
|
};
|
|
|
|
self.validate_edge(&edge, EdgeExistence::DoesNotExist)?;
|
|
|
|
{
|
|
let output_node = self.get_node_state_mut(output_node_id)?;
|
|
output_node.edges.add_output_edge(edge.clone())?;
|
|
}
|
|
let input_node = self.get_node_state_mut(input_node_id)?;
|
|
input_node.edges.add_input_edge(edge)?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Adds the [`Edge::SlotEdge`] to the graph. This guarantees that the `output_node`
|
|
/// is run before the `input_node` and also connects the `output_slot` to the `input_slot`.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Any invalid [`NodeLabel`]s or [`SlotLabel`]s are given.
|
|
///
|
|
/// # See also
|
|
///
|
|
/// - [`try_add_slot_edge`](Self::try_add_slot_edge) for a fallible version.
|
|
pub fn add_slot_edge(
|
|
&mut self,
|
|
output_node: impl Into<NodeLabel>,
|
|
output_slot: impl Into<SlotLabel>,
|
|
input_node: impl Into<NodeLabel>,
|
|
input_slot: impl Into<SlotLabel>,
|
|
) {
|
|
self.try_add_slot_edge(output_node, output_slot, input_node, input_slot)
|
|
.unwrap();
|
|
}
|
|
|
|
/// Removes the [`Edge::SlotEdge`] from the graph. If any nodes or slots do not exist then
|
|
/// nothing happens.
|
|
pub fn remove_slot_edge(
|
|
&mut self,
|
|
output_node: impl Into<NodeLabel>,
|
|
output_slot: impl Into<SlotLabel>,
|
|
input_node: impl Into<NodeLabel>,
|
|
input_slot: impl Into<SlotLabel>,
|
|
) -> Result<(), RenderGraphError> {
|
|
let output_slot = output_slot.into();
|
|
let input_slot = input_slot.into();
|
|
let output_node_id = self.get_node_id(output_node)?;
|
|
let input_node_id = self.get_node_id(input_node)?;
|
|
|
|
let output_index = self
|
|
.get_node_state(output_node_id)?
|
|
.output_slots
|
|
.get_slot_index(output_slot.clone())
|
|
.ok_or(RenderGraphError::InvalidOutputNodeSlot(output_slot))?;
|
|
let input_index = self
|
|
.get_node_state(input_node_id)?
|
|
.input_slots
|
|
.get_slot_index(input_slot.clone())
|
|
.ok_or(RenderGraphError::InvalidInputNodeSlot(input_slot))?;
|
|
|
|
let edge = Edge::SlotEdge {
|
|
output_node: output_node_id,
|
|
output_index,
|
|
input_node: input_node_id,
|
|
input_index,
|
|
};
|
|
|
|
self.validate_edge(&edge, EdgeExistence::Exists)?;
|
|
|
|
{
|
|
let output_node = self.get_node_state_mut(output_node_id)?;
|
|
output_node.edges.remove_output_edge(edge.clone())?;
|
|
}
|
|
let input_node = self.get_node_state_mut(input_node_id)?;
|
|
input_node.edges.remove_input_edge(edge)?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Adds the [`Edge::NodeEdge`] to the graph. This guarantees that the `output_node`
|
|
/// is run before the `input_node`.
|
|
///
|
|
/// Fails if any invalid [`NodeLabel`] is given.
|
|
///
|
|
/// # See also
|
|
///
|
|
/// - [`add_node_edge`](Self::add_node_edge) for an infallible version.
|
|
pub fn try_add_node_edge(
|
|
&mut self,
|
|
output_node: impl Into<NodeLabel>,
|
|
input_node: impl Into<NodeLabel>,
|
|
) -> Result<(), RenderGraphError> {
|
|
let output_node_id = self.get_node_id(output_node)?;
|
|
let input_node_id = self.get_node_id(input_node)?;
|
|
|
|
let edge = Edge::NodeEdge {
|
|
output_node: output_node_id,
|
|
input_node: input_node_id,
|
|
};
|
|
|
|
self.validate_edge(&edge, EdgeExistence::DoesNotExist)?;
|
|
|
|
{
|
|
let output_node = self.get_node_state_mut(output_node_id)?;
|
|
output_node.edges.add_output_edge(edge.clone())?;
|
|
}
|
|
let input_node = self.get_node_state_mut(input_node_id)?;
|
|
input_node.edges.add_input_edge(edge)?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Adds the [`Edge::NodeEdge`] to the graph. This guarantees that the `output_node`
|
|
/// is run before the `input_node`.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if any invalid [`NodeLabel`] is given.
|
|
///
|
|
/// # See also
|
|
///
|
|
/// - [`try_add_node_edge`](Self::try_add_node_edge) for a fallible version.
|
|
pub fn add_node_edge(
|
|
&mut self,
|
|
output_node: impl Into<NodeLabel>,
|
|
input_node: impl Into<NodeLabel>,
|
|
) {
|
|
self.try_add_node_edge(output_node, input_node).unwrap();
|
|
}
|
|
|
|
/// Removes the [`Edge::NodeEdge`] from the graph. If either node does not exist then nothing
|
|
/// happens.
|
|
pub fn remove_node_edge(
|
|
&mut self,
|
|
output_node: impl Into<NodeLabel>,
|
|
input_node: impl Into<NodeLabel>,
|
|
) -> Result<(), RenderGraphError> {
|
|
let output_node_id = self.get_node_id(output_node)?;
|
|
let input_node_id = self.get_node_id(input_node)?;
|
|
|
|
let edge = Edge::NodeEdge {
|
|
output_node: output_node_id,
|
|
input_node: input_node_id,
|
|
};
|
|
|
|
self.validate_edge(&edge, EdgeExistence::Exists)?;
|
|
|
|
{
|
|
let output_node = self.get_node_state_mut(output_node_id)?;
|
|
output_node.edges.remove_output_edge(edge.clone())?;
|
|
}
|
|
let input_node = self.get_node_state_mut(input_node_id)?;
|
|
input_node.edges.remove_input_edge(edge)?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Verifies that the edge existence is as expected and
|
|
/// checks that slot edges are connected correctly.
|
|
pub fn validate_edge(
|
|
&mut self,
|
|
edge: &Edge,
|
|
should_exist: EdgeExistence,
|
|
) -> Result<(), RenderGraphError> {
|
|
if should_exist == EdgeExistence::Exists && !self.has_edge(edge) {
|
|
return Err(RenderGraphError::EdgeDoesNotExist(edge.clone()));
|
|
} else if should_exist == EdgeExistence::DoesNotExist && self.has_edge(edge) {
|
|
return Err(RenderGraphError::EdgeAlreadyExists(edge.clone()));
|
|
}
|
|
|
|
match *edge {
|
|
Edge::SlotEdge {
|
|
output_node,
|
|
output_index,
|
|
input_node,
|
|
input_index,
|
|
} => {
|
|
let output_node_state = self.get_node_state(output_node)?;
|
|
let input_node_state = self.get_node_state(input_node)?;
|
|
|
|
let output_slot = output_node_state
|
|
.output_slots
|
|
.get_slot(output_index)
|
|
.ok_or(RenderGraphError::InvalidOutputNodeSlot(SlotLabel::Index(
|
|
output_index,
|
|
)))?;
|
|
let input_slot = input_node_state.input_slots.get_slot(input_index).ok_or(
|
|
RenderGraphError::InvalidInputNodeSlot(SlotLabel::Index(input_index)),
|
|
)?;
|
|
|
|
if let Some(Edge::SlotEdge {
|
|
output_node: current_output_node,
|
|
..
|
|
}) = input_node_state.edges.input_edges().iter().find(|e| {
|
|
if let Edge::SlotEdge {
|
|
input_index: current_input_index,
|
|
..
|
|
} = e
|
|
{
|
|
input_index == *current_input_index
|
|
} else {
|
|
false
|
|
}
|
|
}) {
|
|
if should_exist == EdgeExistence::DoesNotExist {
|
|
return Err(RenderGraphError::NodeInputSlotAlreadyOccupied {
|
|
node: input_node,
|
|
input_slot: input_index,
|
|
occupied_by_node: *current_output_node,
|
|
});
|
|
}
|
|
}
|
|
|
|
if output_slot.slot_type != input_slot.slot_type {
|
|
return Err(RenderGraphError::MismatchedNodeSlots {
|
|
output_node,
|
|
output_slot: output_index,
|
|
input_node,
|
|
input_slot: input_index,
|
|
});
|
|
}
|
|
}
|
|
Edge::NodeEdge { .. } => { /* nothing to validate here */ }
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Checks whether the `edge` already exists in the graph.
|
|
pub fn has_edge(&self, edge: &Edge) -> bool {
|
|
let output_node_state = self.get_node_state(edge.get_output_node());
|
|
let input_node_state = self.get_node_state(edge.get_input_node());
|
|
if let Ok(output_node_state) = output_node_state {
|
|
if output_node_state.edges.output_edges().contains(edge) {
|
|
if let Ok(input_node_state) = input_node_state {
|
|
if input_node_state.edges.input_edges().contains(edge) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
false
|
|
}
|
|
|
|
/// Returns an iterator over the [`NodeStates`](NodeState).
|
|
pub fn iter_nodes(&self) -> impl Iterator<Item = &NodeState> {
|
|
self.nodes.values()
|
|
}
|
|
|
|
/// Returns an iterator over the [`NodeStates`](NodeState), that allows modifying each value.
|
|
pub fn iter_nodes_mut(&mut self) -> impl Iterator<Item = &mut NodeState> {
|
|
self.nodes.values_mut()
|
|
}
|
|
|
|
/// Returns an iterator over the sub graphs.
|
|
pub fn iter_sub_graphs(&self) -> impl Iterator<Item = (&str, &RenderGraph)> {
|
|
self.sub_graphs
|
|
.iter()
|
|
.map(|(name, graph)| (name.as_ref(), graph))
|
|
}
|
|
|
|
/// Returns an iterator over the sub graphs, that allows modifying each value.
|
|
pub fn iter_sub_graphs_mut(&mut self) -> impl Iterator<Item = (&str, &mut RenderGraph)> {
|
|
self.sub_graphs
|
|
.iter_mut()
|
|
.map(|(name, graph)| (name.as_ref(), graph))
|
|
}
|
|
|
|
/// Returns an iterator over a tuple of the input edges and the corresponding output nodes
|
|
/// for the node referenced by the label.
|
|
pub fn iter_node_inputs(
|
|
&self,
|
|
label: impl Into<NodeLabel>,
|
|
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError> {
|
|
let node = self.get_node_state(label)?;
|
|
Ok(node
|
|
.edges
|
|
.input_edges()
|
|
.iter()
|
|
.map(|edge| (edge, edge.get_output_node()))
|
|
.map(move |(edge, output_node_id)| {
|
|
(edge, self.get_node_state(output_node_id).unwrap())
|
|
}))
|
|
}
|
|
|
|
/// Returns an iterator over a tuple of the output edges and the corresponding input nodes
|
|
/// for the node referenced by the label.
|
|
pub fn iter_node_outputs(
|
|
&self,
|
|
label: impl Into<NodeLabel>,
|
|
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError> {
|
|
let node = self.get_node_state(label)?;
|
|
Ok(node
|
|
.edges
|
|
.output_edges()
|
|
.iter()
|
|
.map(|edge| (edge, edge.get_input_node()))
|
|
.map(move |(edge, input_node_id)| (edge, self.get_node_state(input_node_id).unwrap())))
|
|
}
|
|
|
|
/// Adds the `sub_graph` with the `name` to the graph.
|
|
/// If the name is already present replaces it instead.
|
|
pub fn add_sub_graph(&mut self, name: impl Into<Cow<'static, str>>, sub_graph: RenderGraph) {
|
|
self.sub_graphs.insert(name.into(), sub_graph);
|
|
}
|
|
|
|
/// Removes the `sub_graph` with the `name` from the graph.
|
|
/// If the name does not exist then nothing happens.
|
|
pub fn remove_sub_graph(&mut self, name: impl Into<Cow<'static, str>>) {
|
|
self.sub_graphs.remove(&name.into());
|
|
}
|
|
|
|
/// Retrieves the sub graph corresponding to the `name`.
|
|
pub fn get_sub_graph(&self, name: impl AsRef<str>) -> Option<&RenderGraph> {
|
|
self.sub_graphs.get(name.as_ref())
|
|
}
|
|
|
|
/// Retrieves the sub graph corresponding to the `name` mutably.
|
|
pub fn get_sub_graph_mut(&mut self, name: impl AsRef<str>) -> Option<&mut RenderGraph> {
|
|
self.sub_graphs.get_mut(name.as_ref())
|
|
}
|
|
}
|
|
|
|
impl Debug for RenderGraph {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
for node in self.iter_nodes() {
|
|
writeln!(f, "{:?}", node.id)?;
|
|
writeln!(f, " in: {:?}", node.input_slots)?;
|
|
writeln!(f, " out: {:?}", node.output_slots)?;
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
/// A [`Node`] which acts as an entry point for a [`RenderGraph`] with custom inputs.
|
|
/// It has the same input and output slots and simply copies them over when run.
|
|
pub struct GraphInputNode {
|
|
inputs: Vec<SlotInfo>,
|
|
}
|
|
|
|
impl Node for GraphInputNode {
|
|
fn input(&self) -> Vec<SlotInfo> {
|
|
self.inputs.clone()
|
|
}
|
|
|
|
fn output(&self) -> Vec<SlotInfo> {
|
|
self.inputs.clone()
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
graph: &mut RenderGraphContext,
|
|
_render_context: &mut RenderContext,
|
|
_world: &World,
|
|
) -> Result<(), NodeRunError> {
|
|
for i in 0..graph.inputs().len() {
|
|
let input = graph.inputs()[i].clone();
|
|
graph.set_output(i, input)?;
|
|
}
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use crate::{
|
|
render_graph::{
|
|
Edge, Node, NodeId, NodeRunError, RenderGraph, RenderGraphContext, RenderGraphError,
|
|
SlotInfo, SlotType,
|
|
},
|
|
renderer::RenderContext,
|
|
};
|
|
use bevy_ecs::world::World;
|
|
use bevy_utils::HashSet;
|
|
|
|
#[derive(Debug)]
|
|
struct TestNode {
|
|
inputs: Vec<SlotInfo>,
|
|
outputs: Vec<SlotInfo>,
|
|
}
|
|
|
|
impl TestNode {
|
|
pub fn new(inputs: usize, outputs: usize) -> Self {
|
|
TestNode {
|
|
inputs: (0..inputs)
|
|
.map(|i| SlotInfo::new(format!("in_{i}"), SlotType::TextureView))
|
|
.collect(),
|
|
outputs: (0..outputs)
|
|
.map(|i| SlotInfo::new(format!("out_{i}"), SlotType::TextureView))
|
|
.collect(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Node for TestNode {
|
|
fn input(&self) -> Vec<SlotInfo> {
|
|
self.inputs.clone()
|
|
}
|
|
|
|
fn output(&self) -> Vec<SlotInfo> {
|
|
self.outputs.clone()
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_: &mut RenderGraphContext,
|
|
_: &mut RenderContext,
|
|
_: &World,
|
|
) -> Result<(), NodeRunError> {
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_graph_edges() {
|
|
let mut graph = RenderGraph::default();
|
|
let a_id = graph.add_node("A", TestNode::new(0, 1));
|
|
let b_id = graph.add_node("B", TestNode::new(0, 1));
|
|
let c_id = graph.add_node("C", TestNode::new(1, 1));
|
|
let d_id = graph.add_node("D", TestNode::new(1, 0));
|
|
|
|
graph.add_slot_edge("A", "out_0", "C", "in_0");
|
|
graph.add_node_edge("B", "C");
|
|
graph.add_slot_edge("C", 0, "D", 0);
|
|
|
|
fn input_nodes(name: &'static str, graph: &RenderGraph) -> HashSet<NodeId> {
|
|
graph
|
|
.iter_node_inputs(name)
|
|
.unwrap()
|
|
.map(|(_edge, node)| node.id)
|
|
.collect::<HashSet<NodeId>>()
|
|
}
|
|
|
|
fn output_nodes(name: &'static str, graph: &RenderGraph) -> HashSet<NodeId> {
|
|
graph
|
|
.iter_node_outputs(name)
|
|
.unwrap()
|
|
.map(|(_edge, node)| node.id)
|
|
.collect::<HashSet<NodeId>>()
|
|
}
|
|
|
|
assert!(input_nodes("A", &graph).is_empty(), "A has no inputs");
|
|
assert!(
|
|
output_nodes("A", &graph) == HashSet::from_iter(vec![c_id]),
|
|
"A outputs to C"
|
|
);
|
|
|
|
assert!(input_nodes("B", &graph).is_empty(), "B has no inputs");
|
|
assert!(
|
|
output_nodes("B", &graph) == HashSet::from_iter(vec![c_id]),
|
|
"B outputs to C"
|
|
);
|
|
|
|
assert!(
|
|
input_nodes("C", &graph) == HashSet::from_iter(vec![a_id, b_id]),
|
|
"A and B input to C"
|
|
);
|
|
assert!(
|
|
output_nodes("C", &graph) == HashSet::from_iter(vec![d_id]),
|
|
"C outputs to D"
|
|
);
|
|
|
|
assert!(
|
|
input_nodes("D", &graph) == HashSet::from_iter(vec![c_id]),
|
|
"C inputs to D"
|
|
);
|
|
assert!(output_nodes("D", &graph).is_empty(), "D has no outputs");
|
|
}
|
|
|
|
#[test]
|
|
fn test_get_node_typed() {
|
|
struct MyNode {
|
|
value: usize,
|
|
}
|
|
|
|
impl Node for MyNode {
|
|
fn run(
|
|
&self,
|
|
_: &mut RenderGraphContext,
|
|
_: &mut RenderContext,
|
|
_: &World,
|
|
) -> Result<(), NodeRunError> {
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
let mut graph = RenderGraph::default();
|
|
|
|
graph.add_node("A", MyNode { value: 42 });
|
|
|
|
let node: &MyNode = graph.get_node("A").unwrap();
|
|
assert_eq!(node.value, 42, "node value matches");
|
|
|
|
let result: Result<&TestNode, RenderGraphError> = graph.get_node("A");
|
|
assert_eq!(
|
|
result.unwrap_err(),
|
|
RenderGraphError::WrongNodeType,
|
|
"expect a wrong node type error"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_slot_already_occupied() {
|
|
let mut graph = RenderGraph::default();
|
|
|
|
graph.add_node("A", TestNode::new(0, 1));
|
|
graph.add_node("B", TestNode::new(0, 1));
|
|
graph.add_node("C", TestNode::new(1, 1));
|
|
|
|
graph.add_slot_edge("A", 0, "C", 0);
|
|
assert_eq!(
|
|
graph.try_add_slot_edge("B", 0, "C", 0),
|
|
Err(RenderGraphError::NodeInputSlotAlreadyOccupied {
|
|
node: graph.get_node_id("C").unwrap(),
|
|
input_slot: 0,
|
|
occupied_by_node: graph.get_node_id("A").unwrap(),
|
|
}),
|
|
"Adding to a slot that is already occupied should return an error"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_edge_already_exists() {
|
|
let mut graph = RenderGraph::default();
|
|
|
|
graph.add_node("A", TestNode::new(0, 1));
|
|
graph.add_node("B", TestNode::new(1, 0));
|
|
|
|
graph.add_slot_edge("A", 0, "B", 0);
|
|
assert_eq!(
|
|
graph.try_add_slot_edge("A", 0, "B", 0),
|
|
Err(RenderGraphError::EdgeAlreadyExists(Edge::SlotEdge {
|
|
output_node: graph.get_node_id("A").unwrap(),
|
|
output_index: 0,
|
|
input_node: graph.get_node_id("B").unwrap(),
|
|
input_index: 0,
|
|
})),
|
|
"Adding to a duplicate edge should return an error"
|
|
);
|
|
}
|
|
}
|