70 lines
18 KiB
HTML
70 lines
18 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Adds common `RenderGraph` operations to `SubApp` (and `App`)."><title>RenderGraphApp in bevy_render::render_graph - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bevy_render" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../bevy_render/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bevy_render/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../bevy_render/index.html">bevy_<wbr>render</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Render<wbr>Graph<wbr>App</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.add_render_graph_edge" title="add_render_graph_edge">add_render_graph_edge</a></li><li><a href="#tymethod.add_render_graph_edges" title="add_render_graph_edges">add_render_graph_edges</a></li><li><a href="#tymethod.add_render_graph_node" title="add_render_graph_node">add_render_graph_node</a></li><li><a href="#tymethod.add_render_sub_graph" title="add_render_sub_graph">add_render_sub_graph</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-RenderGraphApp-for-App" title="App">App</a></li><li><a href="#impl-RenderGraphApp-for-SubApp" title="SubApp">SubApp</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In bevy_<wbr>render::<wbr>render_<wbr>graph</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bevy_render</a>::<wbr><a href="index.html">render_graph</a></span><h1>Trait <span class="trait">RenderGraphApp</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bevy_render/render_graph/app.rs.html#8-33">Source</a> </span></div><pre class="rust item-decl"><code>pub trait RenderGraphApp {
|
|
// Required methods
|
|
fn <a href="#tymethod.add_render_sub_graph" class="fn">add_render_sub_graph</a>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
) -> &mut Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.add_render_graph_node" class="fn">add_render_graph_node</a><T: <a class="trait" href="trait.Node.html" title="trait bevy_render::render_graph::Node">Node</a> + <a class="trait" href="../../bevy_ecs/world/trait.FromWorld.html" title="trait bevy_ecs::world::FromWorld">FromWorld</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
node_label: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.add_render_graph_edges" class="fn">add_render_graph_edges</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
edges: impl <a class="trait" href="trait.IntoRenderNodeArray.html" title="trait bevy_render::render_graph::IntoRenderNodeArray">IntoRenderNodeArray</a><N>,
|
|
) -> &mut Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.add_render_graph_edge" class="fn">add_render_graph_edge</a>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
output_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
input_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Adds common <a href="struct.RenderGraph.html" title="struct bevy_render::render_graph::RenderGraph"><code>RenderGraph</code></a> operations to <a href="../../bevy_app/sub_app/struct.SubApp.html" title="struct bevy_app::sub_app::SubApp"><code>SubApp</code></a> (and <a href="../../bevy_app/app/struct.App.html" title="struct bevy_app::app::App"><code>App</code></a>).</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.add_render_sub_graph" class="method"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#10">Source</a><h4 class="code-header">fn <a href="#tymethod.add_render_sub_graph" class="fn">add_render_sub_graph</a>(&mut self, sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>) -> &mut Self</h4></section><details class="toggle method-toggle" open><summary><section id="tymethod.add_render_graph_node" class="method"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#14-18">Source</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_node" class="fn">add_render_graph_node</a><T: <a class="trait" href="trait.Node.html" title="trait bevy_render::render_graph::Node">Node</a> + <a class="trait" href="../../bevy_ecs/world/trait.FromWorld.html" title="trait bevy_ecs::world::FromWorld">FromWorld</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
node_label: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self</h4></section></summary><div class="docblock"><p>Add a <a href="trait.Node.html" title="trait bevy_render::render_graph::Node"><code>Node</code></a> to the <a href="struct.RenderGraph.html" title="struct bevy_render::render_graph::RenderGraph"><code>RenderGraph</code></a>:</p>
|
|
<ul>
|
|
<li>Create the <a href="trait.Node.html" title="trait bevy_render::render_graph::Node"><code>Node</code></a> using the <a href="../../bevy_ecs/world/trait.FromWorld.html" title="trait bevy_ecs::world::FromWorld"><code>FromWorld</code></a> implementation</li>
|
|
<li>Add it to the graph</li>
|
|
</ul>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.add_render_graph_edges" class="method"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#20-24">Source</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_edges" class="fn">add_render_graph_edges</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
edges: impl <a class="trait" href="trait.IntoRenderNodeArray.html" title="trait bevy_render::render_graph::IntoRenderNodeArray">IntoRenderNodeArray</a><N>,
|
|
) -> &mut Self</h4></section></summary><div class="docblock"><p>Automatically add the required node edges based on the given ordering</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.add_render_graph_edge" class="method"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#27-32">Source</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_edge" class="fn">add_render_graph_edge</a>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
output_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
input_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self</h4></section></summary><div class="docblock"><p>Add node edge to the specified graph</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-RenderGraphApp-for-App" class="impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#104-137">Source</a><a href="#impl-RenderGraphApp-for-App" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RenderGraphApp.html" title="trait bevy_render::render_graph::RenderGraphApp">RenderGraphApp</a> for <a class="struct" href="../../bevy_app/app/struct.App.html" title="struct bevy_app::app::App">App</a></h3></section></summary><div class="impl-items"><section id="method.add_render_graph_node" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#105-112">Source</a><a href="#method.add_render_graph_node" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_node" class="fn">add_render_graph_node</a><T: <a class="trait" href="trait.Node.html" title="trait bevy_render::render_graph::Node">Node</a> + <a class="trait" href="../../bevy_ecs/world/trait.FromWorld.html" title="trait bevy_ecs::world::FromWorld">FromWorld</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
node_label: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self</h4></section><section id="method.add_render_graph_edge" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#114-122">Source</a><a href="#method.add_render_graph_edge" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_edge" class="fn">add_render_graph_edge</a>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
output_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
input_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self</h4></section><section id="method.add_render_graph_edges" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#124-131">Source</a><a href="#method.add_render_graph_edges" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_edges" class="fn">add_render_graph_edges</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
edges: impl <a class="trait" href="trait.IntoRenderNodeArray.html" title="trait bevy_render::render_graph::IntoRenderNodeArray">IntoRenderNodeArray</a><N>,
|
|
) -> &mut Self</h4></section><section id="method.add_render_sub_graph" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#133-136">Source</a><a href="#method.add_render_sub_graph" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_sub_graph" class="fn">add_render_sub_graph</a>(&mut self, sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>) -> &mut Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-RenderGraphApp-for-SubApp" class="impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#35-102">Source</a><a href="#impl-RenderGraphApp-for-SubApp" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RenderGraphApp.html" title="trait bevy_render::render_graph::RenderGraphApp">RenderGraphApp</a> for <a class="struct" href="../../bevy_app/sub_app/struct.SubApp.html" title="struct bevy_app::sub_app::SubApp">SubApp</a></h3></section></summary><div class="impl-items"><section id="method.add_render_graph_node-1" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#36-54">Source</a><a href="#method.add_render_graph_node-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_node" class="fn">add_render_graph_node</a><T: <a class="trait" href="trait.Node.html" title="trait bevy_render::render_graph::Node">Node</a> + <a class="trait" href="../../bevy_ecs/world/trait.FromWorld.html" title="trait bevy_ecs::world::FromWorld">FromWorld</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
node_label: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self</h4></section><section id="method.add_render_graph_edges-1" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#56-73">Source</a><a href="#method.add_render_graph_edges-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_edges" class="fn">add_render_graph_edges</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
edges: impl <a class="trait" href="trait.IntoRenderNodeArray.html" title="trait bevy_render::render_graph::IntoRenderNodeArray">IntoRenderNodeArray</a><N>,
|
|
) -> &mut Self</h4></section><section id="method.add_render_graph_edge-1" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#75-93">Source</a><a href="#method.add_render_graph_edge-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_graph_edge" class="fn">add_render_graph_edge</a>(
|
|
&mut self,
|
|
sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>,
|
|
output_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
input_node: impl <a class="trait" href="trait.RenderLabel.html" title="trait bevy_render::render_graph::RenderLabel">RenderLabel</a>,
|
|
) -> &mut Self</h4></section><section id="method.add_render_sub_graph-1" class="method trait-impl"><a class="src rightside" href="../../src/bevy_render/render_graph/app.rs.html#95-101">Source</a><a href="#method.add_render_sub_graph-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_render_sub_graph" class="fn">add_render_sub_graph</a>(&mut self, sub_graph: impl <a class="trait" href="trait.RenderSubGraph.html" title="trait bevy_render::render_graph::RenderSubGraph">RenderSubGraph</a>) -> &mut Self</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/bevy_render/render_graph/app/trait.RenderGraphApp.js" data-ignore-extern-crates="bevy_app" async></script></section></div></main></body></html> |