4 lines
7.0 KiB
HTML
4 lines
7.0 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="Types that detect when their internal data mutate."><title>bevy_ecs::change_detection - 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 mod"><!--[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="#">Module change_<wbr>detection</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bevy_<wbr>ecs</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></span><h1>Module <span>change_detection</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/change_detection.rs.html#1-1566">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types that detect when their internal data mutate.</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut">Mut</a></div><div class="desc docblock-short">Unique mutable borrow of an entity’s component or of a resource.</div></li><li><div class="item-name"><a class="struct" href="struct.MutUntyped.html" title="struct bevy_ecs::change_detection::MutUntyped">MutUntyped</a></div><div class="desc docblock-short">Unique mutable borrow of resources or an entity’s component.</div></li><li><div class="item-name"><a class="struct" href="struct.NonSendMut.html" title="struct bevy_ecs::change_detection::NonSendMut">NonSend<wbr>Mut</a></div><div class="desc docblock-short">Unique borrow of a non-<a href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send"><code>Send</code></a> resource.</div></li><li><div class="item-name"><a class="struct" href="struct.Ref.html" title="struct bevy_ecs::change_detection::Ref">Ref</a></div><div class="desc docblock-short">Shared borrow of an entity’s component with access to change detection.
|
||
Similar to <a href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut"><code>Mut</code></a> but is immutable and so doesn’t require unique access.</div></li><li><div class="item-name"><a class="struct" href="struct.Res.html" title="struct bevy_ecs::change_detection::Res">Res</a></div><div class="desc docblock-short">Shared borrow of a <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a></div><div class="desc docblock-short">Unique mutable borrow of a <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a>.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.CHECK_TICK_THRESHOLD.html" title="constant bevy_ecs::change_detection::CHECK_TICK_THRESHOLD">CHECK_<wbr>TICK_<wbr>THRESHOLD</a></div><div class="desc docblock-short">The (arbitrarily chosen) minimum number of world tick increments between <code>check_tick</code> scans.</div></li><li><div class="item-name"><a class="constant" href="constant.MAX_CHANGE_AGE.html" title="constant bevy_ecs::change_detection::MAX_CHANGE_AGE">MAX_<wbr>CHANGE_<wbr>AGE</a></div><div class="desc docblock-short">The maximum change tick difference that won’t overflow before the next <code>check_tick</code> scan.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.DetectChanges.html" title="trait bevy_ecs::change_detection::DetectChanges">Detect<wbr>Changes</a></div><div class="desc docblock-short">Types that can read change detection information.
|
||
This change detection is controlled by <a href="trait.DetectChangesMut.html" title="trait bevy_ecs::change_detection::DetectChangesMut"><code>DetectChangesMut</code></a> types such as <a href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut"><code>ResMut</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.DetectChangesMut.html" title="trait bevy_ecs::change_detection::DetectChangesMut">Detect<wbr>Changes<wbr>Mut</a></div><div class="desc docblock-short">Types that implement reliable change detection.</div></li></ul></section></div></main></body></html> |