docs

Author: prokopyl

examples/open_parented/src/main.rs

@@ -1,4 +1,4 @@
-use baseview::dpi::{LogicalSize, PhysicalSize};
+use baseview::dpi::LogicalSize;
 use baseview::{
     Event, EventStatus, HandlerError, WindowContext, WindowHandle, WindowHandler,
     WindowOpenOptions, WindowSize,
@@ -55,7 +55,7 @@ impl WindowHandler for ParentWindowHandler {
         }
 
         let child_size =
-            PhysicalSize::new(new_size.physical.width / 2, new_size.physical.height / 2);
+            LogicalSize::new(new_size.logical.width / 2., new_size.logical.height / 2.);
         self.child_window.suggest_scale_factor(new_size.scale_factor)?;
         self.child_window.resize(child_size.into())?;
         Ok(())

src/window.rs

@@ -25,17 +25,41 @@ impl WindowHandle {
         self.window_handle.size()
     }
 
+    /// Resizes the window to the given [`Size`].
+    ///
+    /// The `size` can be provided in either physical or logical pixels.
     pub fn resize(&self, size: Size) -> Result<(), Error> {
         self.window_handle.resize(size)?;
         Ok(())
     }
 
+    /// Suggests a fallback scale factor, if Baseview couldn't get one from the platform.
+    ///
+    /// If the platform does already provide an accurate scaling factor, this doesn't do anything.
+    ///
+    /// If the given fallback scale factor is actually useful and different from the current one
+    /// (1.0 by default), this will resize and redraw the window accordingly.
+    ///
+    /// # Platform compatibility notes.
+    ///
+    /// On Win32, this is used if running on early versions of Windows 10 (or earlier).
+    ///
+    /// On X11, this is used if no `Xft.dpi`setting is set.
+    ///
+    /// On macOS, this is always a no-op.
     pub fn suggest_scale_factor(&self, scale_factor: f64) -> Result<(), Error> {
         self.window_handle.suggest_scale_factor(scale_factor)?;
         Ok(())
     }
 
-    /// Close the window
+    /// Closes and destroys the window.
+    ///
+    /// This releases all resources the window uses.
+    ///
+    /// It is guaranteed that no other objects (e.g. the parent window) are used by this window after
+    /// this call.
+    ///
+    /// Calling this method is more explicit, but otherwise identical to just dropping this [`WindowHandle`].
     pub fn close(self) {
         drop(self)
     }