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

9 lines
4.6 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="Close windows in response to `WindowCloseRequested` (e.g. when the close button is pressed)."><title>close_when_requested in bevy_window - 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_window" 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_window/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_window/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../bevy_window/index.html">bevy_<wbr>window</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></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_window</a></span><h1>Function <span class="fn">close_when_requested</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_window/system.rs.html#42-58">Source</a> </span></div><pre class="rust item-decl"><code>pub fn close_when_requested(
commands: <a class="struct" href="../bevy_ecs/system/commands/struct.Commands.html" title="struct bevy_ecs::system::commands::Commands">Commands</a>&lt;'_, '_&gt;,
closed: <a class="struct" href="../bevy_ecs/event/reader/struct.EventReader.html" title="struct bevy_ecs::event::reader::EventReader">EventReader</a>&lt;'_, '_, <a class="struct" href="struct.WindowCloseRequested.html" title="struct bevy_window::WindowCloseRequested">WindowCloseRequested</a>&gt;,
closing: <a class="struct" href="../bevy_ecs/system/query/struct.Query.html" title="struct bevy_ecs::system::query::Query">Query</a>&lt;'_, '_, <a class="struct" href="../bevy_ecs/entity/struct.Entity.html" title="struct bevy_ecs::entity::Entity">Entity</a>, <a class="struct" href="../bevy_ecs/query/filter/struct.With.html" title="struct bevy_ecs::query::filter::With">With</a>&lt;<a class="struct" href="struct.ClosingWindow.html" title="struct bevy_window::ClosingWindow">ClosingWindow</a>&gt;&gt;,
)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Close windows in response to <a href="struct.WindowCloseRequested.html" title="struct bevy_window::WindowCloseRequested"><code>WindowCloseRequested</code></a> (e.g. when the close button is pressed).</p>
<p>This system is added by the <a href="struct.WindowPlugin.html" title="struct bevy_window::WindowPlugin"><code>WindowPlugin</code></a> in the default configuration.
To disable this behavior, set <code>close_when_requested</code> (on the <a href="struct.WindowPlugin.html" title="struct bevy_window::WindowPlugin"><code>WindowPlugin</code></a>) to <code>false</code>.
Ensure that you read the caveats documented on that field if doing so.</p>
</div></details></section></div></main></body></html>