migrations/winit
1
0
Fork 0
mirror of https://github.com/rust-windowing/winit.git synced 2026-09-02 14:50:04 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document Window Drop behavior (#3315)

Browse Source
This commit is contained in:
daxpedda
2024-01-17 23:17:36 +01:00
committed by GitHub
parent d1717b6a01
commit aec608f93c
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/window.rs
View File

@@ -19,6 +19,7 @@ use serde::{Deserialize, Serialize};
/// Represents a window. /// Represents a window.
/// ///
/// The window is closed when dropped.
/// ///
/// # Threading /// # Threading
/// ///
@@ -30,7 +31,6 @@ use serde::{Deserialize, Serialize};
/// window from a thread other than the main, the code is scheduled to run on /// window from a thread other than the main, the code is scheduled to run on
/// the main thread, and your thread may be blocked until that completes. /// the main thread, and your thread may be blocked until that completes.
/// ///
///
/// # Example /// # Example
/// ///
/// ```no_run /// ```no_run
@@ -54,6 +54,11 @@ use serde::{Deserialize, Serialize};
/// } /// }
/// }); /// });
/// ``` /// ```
///
/// ## Platform-specific
///
/// **Web:** The [`Window`], which is represented by a `HTMLElementCanvas`, can
/// not be closed by dropping the [`Window`].
pub struct Window { pub struct Window {
pub(crate) window: platform_impl::Window, pub(crate) window: platform_impl::Window,
} }
@@ -65,6 +70,9 @@ impl fmt::Debug for Window {
} }
impl Drop for Window { impl Drop for Window {
/// This will close the [`Window`].
///
/// See [`Window`] for more details.
fn drop(&mut self) { fn drop(&mut self) {
self.window.maybe_wait_on_main(|w| { self.window.maybe_wait_on_main(|w| {
// If the window is in exclusive fullscreen, we must restore the desktop // If the window is in exclusive fullscreen, we must restore the desktop