Files
phy/bevy_ecs/schedule/fn.apply_deferred.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

19 lines
5.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Instructs the executor to call `System::apply_deferred` on the systems that have run but not applied their `Deferred` system parameters (like `Commands`) or other system buffers."><title>apply_deferred in bevy_ecs::schedule - 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_ecs" 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 fn"><!--[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_ecs/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_ecs/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../bevy_ecs/index.html">bevy_<wbr>ecs</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">apply_<wbr>deferred</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#scheduling" title="Scheduling">Scheduling</a></li><li><a href="#notes" title="Notes">Notes</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In bevy_<wbr>ecs::<wbr>schedule</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_ecs</a>::<wbr><a href="index.html">schedule</a></span><h1>Function <span class="fn">apply_deferred</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_ecs/schedule/executor/mod.rs.html#122">Source</a> </span></div><pre class="rust item-decl"><code>pub fn apply_deferred(world: &amp;mut <a class="struct" href="../world/struct.World.html" title="struct bevy_ecs::world::World">World</a>)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Instructs the executor to call <a href="../system/trait.System.html#tymethod.apply_deferred" title="method bevy_ecs::system::System::apply_deferred"><code>System::apply_deferred</code></a>
on the systems that have run but not applied their <a href="../system/struct.Deferred.html" title="struct bevy_ecs::system::Deferred"><code>Deferred</code></a> system parameters
(like <a href="../system/struct.Commands.html" title="struct bevy_ecs::system::Commands"><code>Commands</code></a>) or other system buffers.</p>
<h3 id="scheduling"><a class="doc-anchor" href="#scheduling">§</a>Scheduling</h3>
<p><code>apply_deferred</code> systems are scheduled <em>by default</em></p>
<ul>
<li>later in the same schedule run (for example, if a system with <code>Commands</code> param
is scheduled in <code>Update</code>, all the changes will be visible in <code>PostUpdate</code>)</li>
<li>between systems with dependencies if the dependency
<a href="../system/trait.System.html#tymethod.has_deferred" title="method bevy_ecs::system::System::has_deferred">has deferred buffers</a>
(if system <code>bar</code> directly or indirectly depends on <code>foo</code>, and <code>foo</code> uses <code>Commands</code> param,
changes to the world in <code>foo</code> will be visible in <code>bar</code>)</li>
</ul>
<h3 id="notes"><a class="doc-anchor" href="#notes">§</a>Notes</h3>
<ul>
<li>This function (currently) does nothing if its called manually or wrapped inside a <a href="../system/struct.PipeSystem.html" title="struct bevy_ecs::system::PipeSystem"><code>PipeSystem</code></a>.</li>
<li>Modifying a <a href="struct.Schedule.html" title="struct bevy_ecs::schedule::Schedule"><code>Schedule</code></a> may change the order buffers are applied.</li>
</ul>
</div></details></section></div></main></body></html>