Make Viewport::zoom public to replace methods and add docs

Author: matthunz

packages/blitz-dom/src/image.rs

@@ -1,12 +1,17 @@
 use taffy::{MaybeMath, MaybeResolve};
 
+/// Layout context for an image.
 #[derive(Debug, Clone, Copy)]
 pub struct ImageContext {
+    /// Inherent size of the image.
     pub inherent_size: taffy::Size<f32>,
+
+    /// Specified size of the image.
     pub attr_size: taffy::Size<Option<f32>>,
 }
 
-pub fn image_measure_function(
+/// Measure an image.
+pub fn measure_image(
     known_dimensions: taffy::Size<Option<f32>>,
     parent_size: taffy::Size<Option<f32>>,
     image_context: &ImageContext,

packages/blitz-dom/src/layout/mod.rs

@@ -7,7 +7,7 @@
 use crate::node::{NodeData, NodeKind, NodeSpecificData};
 use crate::{
     document::Document,
-    image::{image_measure_function, ImageContext},
+    image::{measure_image, ImageContext},
     node::Node,
 };
 use html5ever::local_name;
@@ -245,7 +245,7 @@ impl LayoutPartialTree for Document {
                             inputs,
                             &node.style,
                             |known_dimensions, _available_space| {
-                                image_measure_function(
+                                measure_image(
                                     known_dimensions,
                                     inputs.parent_size,
                                     &image_context,

packages/blitz-dom/src/lib.rs

@@ -15,6 +15,7 @@
 /// This is the primary entry point for this crate.
 pub mod document;
 
+/// HTML document data structure.
 pub mod html_document;
 /// An implementation for Html5ever's sink trait, allowing us to parse HTML into a DOM.
 pub mod htmlsink;
@@ -37,14 +38,19 @@ pub mod stylo_to_parley;
 /// Conversions from Stylo types to Taffy and Parley types
 pub mod stylo_to_taffy;
 
+/// Image layout.
 pub mod image;
 
+/// Utility functions.
 pub mod util;
 
+/// Debugging.
 pub mod debug;
 
+/// Events.
 pub mod events;
 
+/// Window viewport.
 pub mod viewport;
 
 pub use document::{Document, DocumentLike};

packages/blitz-dom/src/node.rs

@@ -464,7 +464,7 @@ impl ElementNodeData {
         }
     }
 
-    pub fn flush_is_focussable(&mut self) {
+    pub(crate) fn flush_is_focussable(&mut self) {
         let disabled: bool = self.attr_parsed(local_name!("disabled")).unwrap_or(false);
         let tabindex: Option<i32> = self.attr_parsed(local_name!("tabindex"));
 
@@ -495,7 +495,7 @@ impl ElementNodeData {
             }
     }
 
-    pub fn flush_style_attribute(&mut self, guard: &SharedRwLock) {
+     pub fn flush_style_attribute(&mut self, guard: &SharedRwLock) {
         self.style_attribute = self.attr(local_name!("style")).map(|style_str| {
             let url = UrlExtraData::from(
                 "data:text/css;charset=utf-8;base64,"
@@ -513,6 +513,7 @@ impl ElementNodeData {
         });
     }
 
+    /// Take the current cached inline text layout.
     pub fn take_inline_layout(&mut self) -> Option<Box<TextLayout>> {
         std::mem::take(&mut self.inline_layout_data)
     }

packages/blitz-dom/src/viewport.rs

@@ -4,18 +4,24 @@ use style::{
     properties::{style_structs::Font, ComputedValues},
 };
 
+/// Window viewport.
 #[derive(Default, Debug, Clone)]
 pub struct Viewport {
+    /// Size of the window.
     pub window_size: (u32, u32),
 
-    hidpi_scale: f32,
+    /// Font size.
+    pub font_size: f32,
 
-    zoom: f32,
+    /// Zoom level.
+    pub zoom: f32,
 
-    pub font_size: f32,
+    hidpi_scale: f32,
+    
 }
 
 impl Viewport {
+    /// Create a new viewport from a window's physical size and scale factor.
     pub fn new(physical_width: u32, physical_height: u32, scale_factor: f32) -> Self {
         Self {
             window_size: (physical_width, physical_height),
@@ -25,31 +31,21 @@ impl Viewport {
         }
     }
 
-    // Total scaling, the product of the zoom and hdpi scale
+    /// Total scaling, the product of the zoom and hdpi scale.
     pub fn scale(&self) -> f32 {
         self.hidpi_scale * self.zoom
     }
-    // Total scaling, the product of the zoom and hdpi scale
+    
+    /// Total scaling, the product of the zoom and hdpi scale (as an `f64`).
     pub fn scale_f64(&self) -> f64 {
         self.scale() as f64
     }
 
+    /// Set the hidi scale.
     pub fn set_hidpi_scale(&mut self, scale: f32) {
         self.hidpi_scale = scale;
     }
 
-    pub fn zoom(&self) -> f32 {
-        self.zoom
-    }
-
-    pub fn set_zoom(&mut self, zoom: f32) {
-        self.zoom = zoom;
-    }
-
-    pub fn zoom_mut(&mut self) -> &mut f32 {
-        &mut self.zoom
-    }
-
     pub(crate) fn make_device(&self) -> Device {
         let width = self.window_size.0 as f32 / self.scale();
         let height = self.window_size.1 as f32 / self.scale();

packages/dioxus-native/src/window.rs

@@ -213,8 +213,8 @@ impl<Doc: DocumentLike> View<Doc> {
 
     pub fn mouse_move(&mut self, x: f32, y: f32) -> bool {
         let viewport_scroll = self.dom.as_ref().viewport_scroll();
-        let dom_x = x + viewport_scroll.x as f32 / self.viewport.zoom();
-        let dom_y = y + viewport_scroll.y as f32 / self.viewport.zoom();
+        let dom_x = x + viewport_scroll.x as f32 / self.viewport.zoom;
+        let dom_y = y + viewport_scroll.y as f32 / self.viewport.zoom;
 
         // println!("Mouse move: ({}, {})", x, y);
         // println!("Unscaled: ({}, {})",);
@@ -338,15 +338,15 @@ impl<Doc: DocumentLike> View<Doc> {
                 if ctrl | meta {
                     match key_code {
                         KeyCode::Equal => {
-                            *self.viewport.zoom_mut() += 0.1;
+                            self.viewport.zoom += 0.1;
                             self.kick_dom_viewport();
                         }
                         KeyCode::Minus => {
-                            *self.viewport.zoom_mut() -= 0.1;
+                            self.viewport.zoom -= 0.1;
                             self.kick_dom_viewport();
                         }
                         KeyCode::Digit0 => {
-                            *self.viewport.zoom_mut() = 1.0;
+                            self.viewport.zoom = 1.0;
                             self.kick_dom_viewport();
                         }
                         _ => {}