Document that safe area != occlusion

rust-windowing · Nov 4, 2024 · 4d621a3 · 4d621a3
1 parent b5f91e7
commit 4d621a3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/window.rs b/src/window.rs
@@ -741,6 +741,9 @@ pub trait Window: AsAny + Send + Sync {
     /// of the surface, and the size extending downwards to the right. The area will not extend
     /// beyond [the bounds of the surface][Window::surface_size].
     ///
+    /// Note that the safe area does not take occlusion from other windows into account; in a way,
+    /// it is only a "hardware"-level occlusion.
+    ///
     /// If the entire content of the surface is visible, this returns `((0, 0), surface_size)`.
     ///
     /// ## Platform-specific