Struct bevy::render::render_graph::RenderGraph
pub struct RenderGraph { /* private fields */ }
Expand description
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
, Edges
and Slots
.
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.
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").unwrap();
Implementations§
§impl RenderGraph
impl RenderGraph
pub const INPUT_NODE_NAME: &'static str = "GraphInputNode"
pub const INPUT_NODE_NAME: &'static str = "GraphInputNode"
The name of the GraphInputNode
of this graph. Used to connect other nodes to it.
pub fn update(&mut self, world: &mut World)
pub fn update(&mut self, world: &mut World)
Updates all nodes and sub graphs of the render graph. Should be called before executing it.
pub fn set_input(&mut self, inputs: Vec<SlotInfo, Global>) -> NodeId
pub fn set_input(&mut self, inputs: Vec<SlotInfo, Global>) -> NodeId
Creates an GraphInputNode
with the specified slots if not already present.
pub fn input_node(&self) -> Option<&NodeState>
pub fn input_node(&self) -> Option<&NodeState>
Returns the NodeState
of the input node of this graph..
pub fn add_node<T>(
&mut self,
name: impl Into<Cow<'static, str>>,
node: T
) -> NodeIdwhere
T: Node,
pub fn add_node<T>(
&mut self,
name: impl Into<Cow<'static, str>>,
node: T
) -> NodeIdwhere
T: Node,
Adds the node
with the name
to the graph.
If the name is already present replaces it instead.
pub fn remove_node(
&mut self,
name: impl Into<Cow<'static, str>>
) -> Result<(), RenderGraphError>
pub fn remove_node(
&mut self,
name: impl Into<Cow<'static, str>>
) -> Result<(), RenderGraphError>
Removes the node
with the name
from the graph.
If the name is does not exist, nothing happens.
pub fn get_node_state(
&self,
label: impl Into<NodeLabel>
) -> Result<&NodeState, RenderGraphError>
pub fn get_node_state(
&self,
label: impl Into<NodeLabel>
) -> Result<&NodeState, RenderGraphError>
Retrieves the NodeState
referenced by the label
.
pub fn get_node_state_mut(
&mut self,
label: impl Into<NodeLabel>
) -> Result<&mut NodeState, RenderGraphError>
pub fn get_node_state_mut(
&mut self,
label: impl Into<NodeLabel>
) -> Result<&mut NodeState, RenderGraphError>
Retrieves the NodeState
referenced by the label
mutably.
pub fn get_node_id(
&self,
label: impl Into<NodeLabel>
) -> Result<NodeId, RenderGraphError>
pub fn get_node_id(
&self,
label: impl Into<NodeLabel>
) -> Result<NodeId, RenderGraphError>
Retrieves the NodeId
referenced by the label
.
pub fn get_node<T>(
&self,
label: impl Into<NodeLabel>
) -> Result<&T, RenderGraphError>where
T: Node,
pub fn get_node<T>(
&self,
label: impl Into<NodeLabel>
) -> Result<&T, RenderGraphError>where
T: Node,
Retrieves the Node
referenced by the label
.
pub fn get_node_mut<T>(
&mut self,
label: impl Into<NodeLabel>
) -> Result<&mut T, RenderGraphError>where
T: Node,
pub fn get_node_mut<T>(
&mut self,
label: impl Into<NodeLabel>
) -> Result<&mut T, RenderGraphError>where
T: Node,
Retrieves the Node
referenced by the label
mutably.
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>
) -> Result<(), RenderGraphError>
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>
) -> Result<(), RenderGraphError>
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
.
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>
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>
Removes the Edge::SlotEdge
from the graph. If any nodes or slots do not exist then
nothing happens.
pub fn add_node_edge(
&mut self,
output_node: impl Into<NodeLabel>,
input_node: impl Into<NodeLabel>
) -> Result<(), RenderGraphError>
pub fn add_node_edge(
&mut self,
output_node: impl Into<NodeLabel>,
input_node: impl Into<NodeLabel>
) -> Result<(), RenderGraphError>
Adds the Edge::NodeEdge
to the graph. This guarantees that the output_node
is run before the input_node
.
pub fn remove_node_edge(
&mut self,
output_node: impl Into<NodeLabel>,
input_node: impl Into<NodeLabel>
) -> Result<(), RenderGraphError>
pub fn remove_node_edge(
&mut self,
output_node: impl Into<NodeLabel>,
input_node: impl Into<NodeLabel>
) -> Result<(), RenderGraphError>
Removes the Edge::NodeEdge
from the graph. If either node does not exist then nothing
happens.
pub fn validate_edge(
&mut self,
edge: &Edge,
should_exist: EdgeExistence
) -> Result<(), RenderGraphError>
pub fn validate_edge(
&mut self,
edge: &Edge,
should_exist: EdgeExistence
) -> Result<(), RenderGraphError>
Verifies that the edge existence is as expected and checks that slot edges are connected correctly.
pub fn iter_nodes(&self) -> impl Iterator<Item = &NodeState>
pub fn iter_nodes(&self) -> impl Iterator<Item = &NodeState>
Returns an iterator over the NodeStates
.
pub fn iter_nodes_mut(&mut self) -> impl Iterator<Item = &mut NodeState>
pub fn iter_nodes_mut(&mut self) -> impl Iterator<Item = &mut NodeState>
Returns an iterator over the NodeStates
, that allows modifying each value.
pub fn iter_sub_graphs(&self) -> impl Iterator<Item = (&str, &RenderGraph)>
pub fn iter_sub_graphs(&self) -> impl Iterator<Item = (&str, &RenderGraph)>
Returns an iterator over the sub graphs.
pub fn iter_sub_graphs_mut(
&mut self
) -> impl Iterator<Item = (&str, &mut RenderGraph)>
pub fn iter_sub_graphs_mut(
&mut self
) -> impl Iterator<Item = (&str, &mut RenderGraph)>
Returns an iterator over the sub graphs, that allows modifying each value.
pub fn iter_node_inputs(
&self,
label: impl Into<NodeLabel>
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError>
pub fn iter_node_inputs(
&self,
label: impl Into<NodeLabel>
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError>
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_outputs(
&self,
label: impl Into<NodeLabel>
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError>
pub fn iter_node_outputs(
&self,
label: impl Into<NodeLabel>
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError>
Returns an iterator over a tuple of the output edges and the corresponding input nodes for the node referenced by the label.
pub fn add_sub_graph(
&mut self,
name: impl Into<Cow<'static, str>>,
sub_graph: RenderGraph
)
pub fn add_sub_graph(
&mut self,
name: impl Into<Cow<'static, str>>,
sub_graph: RenderGraph
)
Adds the sub_graph
with the name
to the graph.
If the name is already present replaces it instead.
pub fn remove_sub_graph(&mut self, name: impl Into<Cow<'static, str>>)
pub fn remove_sub_graph(&mut self, name: impl Into<Cow<'static, str>>)
Removes the sub_graph
with the name
from the graph.
If the name does not exist then nothing happens.
pub fn get_sub_graph(&self, name: impl AsRef<str>) -> Option<&RenderGraph>
pub fn get_sub_graph(&self, name: impl AsRef<str>) -> Option<&RenderGraph>
Retrieves the sub graph corresponding to the name
.
pub fn get_sub_graph_mut(
&mut self,
name: impl AsRef<str>
) -> Option<&mut RenderGraph>
pub fn get_sub_graph_mut(
&mut self,
name: impl AsRef<str>
) -> Option<&mut RenderGraph>
Retrieves the sub graph corresponding to the name
mutably.
Trait Implementations§
§impl Debug for RenderGraph
impl Debug for RenderGraph
§impl Default for RenderGraph
impl Default for RenderGraph
§fn default() -> RenderGraph
fn default() -> RenderGraph
impl Resource for RenderGraphwhere
RenderGraph: 'static + Send + Sync,
Auto Trait Implementations§
impl !RefUnwindSafe for RenderGraph
impl Send for RenderGraph
impl Sync for RenderGraph
impl Unpin for RenderGraph
impl !UnwindSafe for RenderGraph
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read more§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World