forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed doc comment with render Node input/output methods (#3642)

Browse Source 
Fixed doc comment where render Node input/output methods refered to using `RenderContext` for interaction instead of `RenderGraphContext`

# Objective

The doc comments for `Node` refer to `RenderContext` for slots instead of `RenderGraphContext`, which is only confusing because `Node::run` is passed both `RenderContext` and `RenderGraphContext`

## Solution

Fixed the typo
This commit is contained in:
Linden Krouse 2022-01-17 20:44:22 +00:00
parent 3fcdc5a492
commit d11cd63452
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/bevy_render/src/render_graph/node.rs
View File

@ -43,13 +43,13 @@ impl NodeId {
/// inside the graph. For more information see [`SlotType`](super::SlotType). /// inside the graph. For more information see [`SlotType`](super::SlotType).
pub trait Node: Downcast + Send + Sync + 'static { pub trait Node: Downcast + Send + Sync + 'static {
/// Specifies the required input slots for this node. /// Specifies the required input slots for this node.
/// They will then be available during the run method inside the [`RenderContext`]. /// They will then be available during the run method inside the [`RenderGraphContext`].
fn input(&self) -> Vec<SlotInfo> { fn input(&self) -> Vec<SlotInfo> {
Vec::new() Vec::new()
} }
/// Specifies the produced output slots for this node. /// Specifies the produced output slots for this node.
/// They can then be passed one inside [`RenderContext`] during the run method. /// They can then be passed one inside [`RenderGraphContext`] during the run method.
fn output(&self) -> Vec<SlotInfo> { fn output(&self) -> Vec<SlotInfo> {
Vec::new() Vec::new()
} }