Struct bevy_render::render_graph::RenderGraph
source · pub struct RenderGraph { /* private fields */ }
Expand description
The render graph configures the modular 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 will execute each node in the graph in the correct order, based on the edges between the nodes.
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.
#[derive(RenderLabel)]
enum Labels {
A,
B,
}
let mut graph = RenderGraph::default();
graph.add_node(Labels::A, MyNode);
graph.add_node(Labels::B, MyNode);
graph.add_node_edge(Labels::B, Labels::A);
Implementations§
source§impl RenderGraph
impl RenderGraph
sourcepub 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.
sourcepub fn set_input(&mut self, inputs: Vec<SlotInfo>)
pub fn set_input(&mut self, inputs: Vec<SlotInfo>)
Creates an GraphInputNode
with the specified slots if not already present.
sourcepub fn get_input_node(&self) -> Option<&NodeState>
pub fn get_input_node(&self) -> Option<&NodeState>
Returns the NodeState
of the input node of this graph.
§See also
input_node
for an unchecked version.
sourcepub fn input_node(&self) -> &NodeState
pub fn input_node(&self) -> &NodeState
Returns the NodeState
of the input node of this graph.
§Panics
Panics if there is no input node set.
§See also
get_input_node
for a version which returns anOption
instead.
sourcepub fn add_node<T>(&mut self, label: impl RenderLabel, node: T)where
T: Node,
pub fn add_node<T>(&mut self, label: impl RenderLabel, node: T)where
T: Node,
Adds the node
with the label
to the graph.
If the label is already present replaces it instead.
sourcepub fn add_node_edges<const N: usize>(
&mut self,
edges: impl IntoRenderNodeArray<N>
)
pub fn add_node_edges<const N: usize>( &mut self, edges: impl IntoRenderNodeArray<N> )
Add node_edge
s based on the order of the given edges
array.
Defining an edge that already exists is not considered an error with this api. It simply won’t create a new edge.
sourcepub fn remove_node(
&mut self,
label: impl RenderLabel
) -> Result<(), RenderGraphError>
pub fn remove_node( &mut self, label: impl RenderLabel ) -> Result<(), RenderGraphError>
Removes the node
with the label
from the graph.
If the label does not exist, nothing happens.
sourcepub fn get_node_state(
&self,
label: impl RenderLabel
) -> Result<&NodeState, RenderGraphError>
pub fn get_node_state( &self, label: impl RenderLabel ) -> Result<&NodeState, RenderGraphError>
Retrieves the NodeState
referenced by the label
.
sourcepub fn get_node_state_mut(
&mut self,
label: impl RenderLabel
) -> Result<&mut NodeState, RenderGraphError>
pub fn get_node_state_mut( &mut self, label: impl RenderLabel ) -> Result<&mut NodeState, RenderGraphError>
Retrieves the NodeState
referenced by the label
mutably.
sourcepub fn get_node<T>(
&self,
label: impl RenderLabel
) -> Result<&T, RenderGraphError>where
T: Node,
pub fn get_node<T>(
&self,
label: impl RenderLabel
) -> Result<&T, RenderGraphError>where
T: Node,
Retrieves the Node
referenced by the label
.
sourcepub fn get_node_mut<T>(
&mut self,
label: impl RenderLabel
) -> Result<&mut T, RenderGraphError>where
T: Node,
pub fn get_node_mut<T>(
&mut self,
label: impl RenderLabel
) -> Result<&mut T, RenderGraphError>where
T: Node,
Retrieves the Node
referenced by the label
mutably.
sourcepub fn try_add_slot_edge(
&mut self,
output_node: impl RenderLabel,
output_slot: impl Into<SlotLabel>,
input_node: impl RenderLabel,
input_slot: impl Into<SlotLabel>
) -> Result<(), RenderGraphError>
pub fn try_add_slot_edge( &mut self, output_node: impl RenderLabel, output_slot: impl Into<SlotLabel>, input_node: impl RenderLabel, 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
.
Fails if any invalid RenderLabel
s or SlotLabel
s are given.
§See also
add_slot_edge
for an infallible version.
sourcepub fn add_slot_edge(
&mut self,
output_node: impl RenderLabel,
output_slot: impl Into<SlotLabel>,
input_node: impl RenderLabel,
input_slot: impl Into<SlotLabel>
)
pub fn add_slot_edge( &mut self, output_node: impl RenderLabel, output_slot: impl Into<SlotLabel>, input_node: impl RenderLabel, input_slot: impl Into<SlotLabel> )
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 RenderLabel
s or SlotLabel
s are given.
§See also
try_add_slot_edge
for a fallible version.
sourcepub fn remove_slot_edge(
&mut self,
output_node: impl RenderLabel,
output_slot: impl Into<SlotLabel>,
input_node: impl RenderLabel,
input_slot: impl Into<SlotLabel>
) -> Result<(), RenderGraphError>
pub fn remove_slot_edge( &mut self, output_node: impl RenderLabel, output_slot: impl Into<SlotLabel>, input_node: impl RenderLabel, 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.
sourcepub fn try_add_node_edge(
&mut self,
output_node: impl RenderLabel,
input_node: impl RenderLabel
) -> Result<(), RenderGraphError>
pub fn try_add_node_edge( &mut self, output_node: impl RenderLabel, input_node: impl RenderLabel ) -> Result<(), RenderGraphError>
Adds the Edge::NodeEdge
to the graph. This guarantees that the output_node
is run before the input_node
.
Fails if any invalid RenderLabel
is given.
§See also
add_node_edge
for an infallible version.
sourcepub fn add_node_edge(
&mut self,
output_node: impl RenderLabel,
input_node: impl RenderLabel
)
pub fn add_node_edge( &mut self, output_node: impl RenderLabel, input_node: impl RenderLabel )
Adds the Edge::NodeEdge
to the graph. This guarantees that the output_node
is run before the input_node
.
§Panics
Panics if any invalid RenderLabel
is given.
§See also
try_add_node_edge
for a fallible version.
sourcepub fn remove_node_edge(
&mut self,
output_node: impl RenderLabel,
input_node: impl RenderLabel
) -> Result<(), RenderGraphError>
pub fn remove_node_edge( &mut self, output_node: impl RenderLabel, input_node: impl RenderLabel ) -> Result<(), RenderGraphError>
Removes the Edge::NodeEdge
from the graph. If either node does not exist then nothing
happens.
sourcepub 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.
sourcepub fn has_edge(&self, edge: &Edge) -> bool
pub fn has_edge(&self, edge: &Edge) -> bool
Checks whether the edge
already exists in the graph.
sourcepub fn iter_nodes(&self) -> impl Iterator<Item = &NodeState>
pub fn iter_nodes(&self) -> impl Iterator<Item = &NodeState>
Returns an iterator over the NodeStates
.
sourcepub 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.
sourcepub fn iter_sub_graphs(
&self
) -> impl Iterator<Item = (InternedRenderSubGraph, &RenderGraph)>
pub fn iter_sub_graphs( &self ) -> impl Iterator<Item = (InternedRenderSubGraph, &RenderGraph)>
Returns an iterator over the sub graphs.
sourcepub fn iter_sub_graphs_mut(
&mut self
) -> impl Iterator<Item = (InternedRenderSubGraph, &mut RenderGraph)>
pub fn iter_sub_graphs_mut( &mut self ) -> impl Iterator<Item = (InternedRenderSubGraph, &mut RenderGraph)>
Returns an iterator over the sub graphs, that allows modifying each value.
sourcepub fn iter_node_inputs(
&self,
label: impl RenderLabel
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError>
pub fn iter_node_inputs( &self, label: impl RenderLabel ) -> 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.
sourcepub fn iter_node_outputs(
&self,
label: impl RenderLabel
) -> Result<impl Iterator<Item = (&Edge, &NodeState)>, RenderGraphError>
pub fn iter_node_outputs( &self, label: impl RenderLabel ) -> 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.
sourcepub fn add_sub_graph(
&mut self,
label: impl RenderSubGraph,
sub_graph: RenderGraph
)
pub fn add_sub_graph( &mut self, label: impl RenderSubGraph, sub_graph: RenderGraph )
Adds the sub_graph
with the label
to the graph.
If the label is already present replaces it instead.
sourcepub fn remove_sub_graph(&mut self, label: impl RenderSubGraph)
pub fn remove_sub_graph(&mut self, label: impl RenderSubGraph)
Removes the sub_graph
with the label
from the graph.
If the label does not exist then nothing happens.
sourcepub fn get_sub_graph(&self, label: impl RenderSubGraph) -> Option<&RenderGraph>
pub fn get_sub_graph(&self, label: impl RenderSubGraph) -> Option<&RenderGraph>
Retrieves the sub graph corresponding to the label
.
sourcepub fn get_sub_graph_mut(
&mut self,
label: impl RenderSubGraph
) -> Option<&mut RenderGraph>
pub fn get_sub_graph_mut( &mut self, label: impl RenderSubGraph ) -> Option<&mut RenderGraph>
Retrieves the sub graph corresponding to the label
mutably.
sourcepub fn sub_graph(&self, label: impl RenderSubGraph) -> &RenderGraph
pub fn sub_graph(&self, label: impl RenderSubGraph) -> &RenderGraph
Retrieves the sub graph corresponding to the label
.
§Panics
Panics if any invalid subgraph label is given.
§See also
get_sub_graph
for a fallible version.
sourcepub fn sub_graph_mut(&mut self, label: impl RenderSubGraph) -> &mut RenderGraph
pub fn sub_graph_mut(&mut self, label: impl RenderSubGraph) -> &mut RenderGraph
Retrieves the sub graph corresponding to the label
mutably.
§Panics
Panics if any invalid subgraph label is given.
§See also
get_sub_graph_mut
for a fallible version.
Trait Implementations§
source§impl Debug for RenderGraph
impl Debug for RenderGraph
source§impl Default for RenderGraph
impl Default for RenderGraph
source§fn default() -> RenderGraph
fn default() -> RenderGraph
impl Resource for RenderGraph
Auto Trait Implementations§
impl Freeze for RenderGraph
impl !RefUnwindSafe for RenderGraph
impl Send for RenderGraph
impl Sync for RenderGraph
impl Unpin for RenderGraph
impl !UnwindSafe for RenderGraph
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§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.source§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.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.