Merge pull request #111 from Maldela/svg

Svg and icon support

8 files changed, 475 insertions, 199 deletions

diff --git a/wgpu/src/image.rs b/wgpu/src/image.rs
index 7e4e2670..4558ffb0 100644
--- a/wgpu/src/image.rs
+++ b/wgpu/src/image.rs
@@ -1,19 +1,17 @@
+mod raster;
+#[cfg(feature = "svg")]
+mod vector;
+
 use crate::Transformation;
-use iced_native::{
-    image::{Data, Handle},
-    Rectangle,
-};
-
-use std::{
-    cell::RefCell,
-    collections::{HashMap, HashSet},
-    mem,
-    rc::Rc,
-};
+use iced_native::{image, svg, Rectangle};
+
+use std::{cell::RefCell, mem};
 
 #[derive(Debug)]
 pub struct Pipeline {
-    cache: RefCell<Cache>,
+    raster_cache: RefCell<raster::Cache>,
+    #[cfg(feature = "svg")]
+    vector_cache: RefCell<vector::Cache>,
 
     pipeline: wgpu::RenderPipeline,
     uniforms: wgpu::Buffer,
@@ -193,7 +191,9 @@ impl Pipeline {
         });
 
         Pipeline {
-            cache: RefCell::new(Cache::new()),
+            raster_cache: RefCell::new(raster::Cache::new()),
+            #[cfg(feature = "svg")]
+            vector_cache: RefCell::new(vector::Cache::new()),
 
             pipeline,
             uniforms: uniforms_buffer,
@@ -205,37 +205,19 @@ impl Pipeline {
         }
     }
 
-    pub fn dimensions(&self, handle: &Handle) -> (u32, u32) {
-        self.load(handle);
+    pub fn dimensions(&self, handle: &image::Handle) -> (u32, u32) {
+        let mut cache = self.raster_cache.borrow_mut();
+        let memory = cache.load(&handle);
 
-        self.cache.borrow_mut().get(handle).unwrap().dimensions()
+        memory.dimensions()
     }
 
-    fn load(&self, handle: &Handle) {
-        if !self.cache.borrow().contains(&handle) {
-            let memory = match handle.data() {
-                Data::Path(path) => {
-                    if let Ok(image) = image::open(path) {
-                        Memory::Host {
-                            image: image.to_bgra(),
-                        }
-                    } else {
-                        Memory::NotFound
-                    }
-                }
-                Data::Bytes(bytes) => {
-                    if let Ok(image) = image::load_from_memory(&bytes) {
-                        Memory::Host {
-                            image: image.to_bgra(),
-                        }
-                    } else {
-                        Memory::Invalid
-                    }
-                }
-            };
+    #[cfg(feature = "svg")]
+    pub fn viewport_dimensions(&self, handle: &svg::Handle) -> (u32, u32) {
+        let mut cache = self.vector_cache.borrow_mut();
+        let svg = cache.load(&handle);
 
-            let _ = self.cache.borrow_mut().insert(&handle, memory);
-        }
+        svg.viewport_dimensions()
     }
 
     pub fn draw(
@@ -246,6 +228,7 @@ impl Pipeline {
         transformation: Transformation,
         bounds: Rectangle<u32>,
         target: &wgpu::TextureView,
+        _scale: f32,
     ) {
         let uniforms_buffer = device
             .create_buffer_mapped(1, wgpu::BufferUsage::COPY_SRC)
@@ -266,15 +249,34 @@ impl Pipeline {
         //
         // [1]: https://github.com/nical/guillotiere
         for image in instances {
-            self.load(&image.handle);
-
-            if let Some(texture) = self
-                .cache
-                .borrow_mut()
-                .get(&image.handle)
-                .unwrap()
-                .upload(device, encoder, &self.texture_layout)
-            {
+            let uploaded_texture = match &image.handle {
+                Handle::Raster(handle) => {
+                    let mut cache = self.raster_cache.borrow_mut();
+                    let memory = cache.load(&handle);
+
+                    memory.upload(device, encoder, &self.texture_layout)
+                }
+                Handle::Vector(_handle) => {
+                    #[cfg(feature = "svg")]
+                    {
+                        let mut cache = self.vector_cache.borrow_mut();
+
+                        cache.upload(
+                            _handle,
+                            image.scale,
+                            _scale,
+                            device,
+                            encoder,
+                            &self.texture_layout,
+                        )
+                    }
+
+                    #[cfg(not(feature = "svg"))]
+                    None
+                }
+            };
+
+            if let Some(texture) = uploaded_texture {
                 let instance_buffer = device
                     .create_buffer_mapped(1, wgpu::BufferUsage::COPY_SRC)
                     .fill_from_slice(&[Instance {
@@ -337,151 +339,10 @@ impl Pipeline {
     }
 
     pub fn trim_cache(&mut self) {
-        self.cache.borrow_mut().trim();
-    }
-}
-
-#[derive(Debug)]
-enum Memory {
-    Host {
-        image: image::ImageBuffer<image::Bgra<u8>, Vec<u8>>,
-    },
-    Device {
-        bind_group: Rc<wgpu::BindGroup>,
-        width: u32,
-        height: u32,
-    },
-    NotFound,
-    Invalid,
-}
-
-impl Memory {
-    fn dimensions(&self) -> (u32, u32) {
-        match self {
-            Memory::Host { image } => image.dimensions(),
-            Memory::Device { width, height, .. } => (*width, *height),
-            Memory::NotFound => (1, 1),
-            Memory::Invalid => (1, 1),
-        }
-    }
-
-    fn upload(
-        &mut self,
-        device: &wgpu::Device,
-        encoder: &mut wgpu::CommandEncoder,
-        texture_layout: &wgpu::BindGroupLayout,
-    ) -> Option<Rc<wgpu::BindGroup>> {
-        match self {
-            Memory::Host { image } => {
-                let (width, height) = image.dimensions();
-
-                let extent = wgpu::Extent3d {
-                    width,
-                    height,
-                    depth: 1,
-                };
-
-                let texture = device.create_texture(&wgpu::TextureDescriptor {
-                    size: extent,
-                    array_layer_count: 1,
-                    mip_level_count: 1,
-                    sample_count: 1,
-                    dimension: wgpu::TextureDimension::D2,
-                    format: wgpu::TextureFormat::Bgra8UnormSrgb,
-                    usage: wgpu::TextureUsage::COPY_DST
-                        | wgpu::TextureUsage::SAMPLED,
-                });
-
-                let slice = image.clone().into_raw();
-
-                let temp_buf = device
-                    .create_buffer_mapped(
-                        slice.len(),
-                        wgpu::BufferUsage::COPY_SRC,
-                    )
-                    .fill_from_slice(&slice[..]);
-
-                encoder.copy_buffer_to_texture(
-                    wgpu::BufferCopyView {
-                        buffer: &temp_buf,
-                        offset: 0,
-                        row_pitch: 4 * width as u32,
-                        image_height: height as u32,
-                    },
-                    wgpu::TextureCopyView {
-                        texture: &texture,
-                        array_layer: 0,
-                        mip_level: 0,
-                        origin: wgpu::Origin3d {
-                            x: 0.0,
-                            y: 0.0,
-                            z: 0.0,
-                        },
-                    },
-                    extent,
-                );
-
-                let bind_group =
-                    device.create_bind_group(&wgpu::BindGroupDescriptor {
-                        layout: texture_layout,
-                        bindings: &[wgpu::Binding {
-                            binding: 0,
-                            resource: wgpu::BindingResource::TextureView(
-                                &texture.create_default_view(),
-                            ),
-                        }],
-                    });
-
-                let bind_group = Rc::new(bind_group);
-
-                *self = Memory::Device {
-                    bind_group: bind_group.clone(),
-                    width,
-                    height,
-                };
+        self.raster_cache.borrow_mut().trim();
 
-                Some(bind_group)
-            }
-            Memory::Device { bind_group, .. } => Some(bind_group.clone()),
-            Memory::NotFound => None,
-            Memory::Invalid => None,
-        }
-    }
-}
-
-#[derive(Debug)]
-struct Cache {
-    map: HashMap<u64, Memory>,
-    hits: HashSet<u64>,
-}
-
-impl Cache {
-    fn new() -> Self {
-        Self {
-            map: HashMap::new(),
-            hits: HashSet::new(),
-        }
-    }
-
-    fn contains(&self, handle: &Handle) -> bool {
-        self.map.contains_key(&handle.id())
-    }
-
-    fn get(&mut self, handle: &Handle) -> Option<&mut Memory> {
-        let _ = self.hits.insert(handle.id());
-
-        self.map.get_mut(&handle.id())
-    }
-
-    fn insert(&mut self, handle: &Handle, memory: Memory) {
-        let _ = self.map.insert(handle.id(), memory);
-    }
-
-    fn trim(&mut self) {
-        let hits = &self.hits;
-
-        self.map.retain(|k, _| hits.contains(k));
-        self.hits.clear();
+        #[cfg(feature = "svg")]
+        self.vector_cache.borrow_mut().trim();
     }
 }
 
@@ -491,6 +352,11 @@ pub struct Image {
     pub scale: [f32; 2],
 }
 
+pub enum Handle {
+    Raster(image::Handle),
+    Vector(svg::Handle),
+}
+
 #[repr(C)]
 #[derive(Clone, Copy)]
 pub struct Vertex {
diff --git a/wgpu/src/image/raster.rs b/wgpu/src/image/raster.rs
new file mode 100644
index 00000000..fa107879
--- /dev/null
+++ b/wgpu/src/image/raster.rs
@@ -0,0 +1,176 @@
+use iced_native::image;
+use std::{
+    collections::{HashMap, HashSet},
+    rc::Rc,
+};
+
+#[derive(Debug)]
+pub enum Memory {
+    Host(::image::ImageBuffer<::image::Bgra<u8>, Vec<u8>>),
+    Device {
+        bind_group: Rc<wgpu::BindGroup>,
+        width: u32,
+        height: u32,
+    },
+    NotFound,
+    Invalid,
+}
+
+impl Memory {
+    pub fn dimensions(&self) -> (u32, u32) {
+        match self {
+            Memory::Host(image) => image.dimensions(),
+            Memory::Device { width, height, .. } => (*width, *height),
+            Memory::NotFound => (1, 1),
+            Memory::Invalid => (1, 1),
+        }
+    }
+
+    pub fn upload(
+        &mut self,
+        device: &wgpu::Device,
+        encoder: &mut wgpu::CommandEncoder,
+        texture_layout: &wgpu::BindGroupLayout,
+    ) -> Option<Rc<wgpu::BindGroup>> {
+        match self {
+            Memory::Host(image) => {
+                let (width, height) = image.dimensions();
+
+                let extent = wgpu::Extent3d {
+                    width,
+                    height,
+                    depth: 1,
+                };
+
+                let texture = device.create_texture(&wgpu::TextureDescriptor {
+                    size: extent,
+                    array_layer_count: 1,
+                    mip_level_count: 1,
+                    sample_count: 1,
+                    dimension: wgpu::TextureDimension::D2,
+                    format: wgpu::TextureFormat::Bgra8UnormSrgb,
+                    usage: wgpu::TextureUsage::COPY_DST
+                        | wgpu::TextureUsage::SAMPLED,
+                });
+
+                let temp_buf = {
+                    let flat_samples = image.as_flat_samples();
+                    let slice = flat_samples.as_slice();
+
+                    device
+                        .create_buffer_mapped(
+                            slice.len(),
+                            wgpu::BufferUsage::COPY_SRC,
+                        )
+                        .fill_from_slice(slice)
+                };
+
+                encoder.copy_buffer_to_texture(
+                    wgpu::BufferCopyView {
+                        buffer: &temp_buf,
+                        offset: 0,
+                        row_pitch: 4 * width as u32,
+                        image_height: height as u32,
+                    },
+                    wgpu::TextureCopyView {
+                        texture: &texture,
+                        array_layer: 0,
+                        mip_level: 0,
+                        origin: wgpu::Origin3d {
+                            x: 0.0,
+                            y: 0.0,
+                            z: 0.0,
+                        },
+                    },
+                    extent,
+                );
+
+                let bind_group =
+                    device.create_bind_group(&wgpu::BindGroupDescriptor {
+                        layout: texture_layout,
+                        bindings: &[wgpu::Binding {
+                            binding: 0,
+                            resource: wgpu::BindingResource::TextureView(
+                                &texture.create_default_view(),
+                            ),
+                        }],
+                    });
+
+                let bind_group = Rc::new(bind_group);
+
+                *self = Memory::Device {
+                    bind_group: bind_group.clone(),
+                    width,
+                    height,
+                };
+
+                Some(bind_group)
+            }
+            Memory::Device { bind_group, .. } => Some(bind_group.clone()),
+            Memory::NotFound => None,
+            Memory::Invalid => None,
+        }
+    }
+}
+
+#[derive(Debug)]
+pub struct Cache {
+    map: HashMap<u64, Memory>,
+    hits: HashSet<u64>,
+}
+
+impl Cache {
+    pub fn new() -> Self {
+        Self {
+            map: HashMap::new(),
+            hits: HashSet::new(),
+        }
+    }
+
+    pub fn load(&mut self, handle: &image::Handle) -> &mut Memory {
+        if self.contains(handle) {
+            return self.get(handle).unwrap();
+        }
+
+        let memory = match handle.data() {
+            image::Data::Path(path) => {
+                if let Ok(image) = ::image::open(path) {
+                    Memory::Host(image.to_bgra())
+                } else {
+                    Memory::NotFound
+                }
+            }
+            image::Data::Bytes(bytes) => {
+                if let Ok(image) = ::image::load_from_memory(&bytes) {
+                    Memory::Host(image.to_bgra())
+                } else {
+                    Memory::Invalid
+                }
+            }
+        };
+
+        self.insert(handle, memory);
+        self.get(handle).unwrap()
+    }
+
+    pub fn trim(&mut self) {
+        let hits = &self.hits;
+
+        self.map.retain(|k, _| hits.contains(k));
+        self.hits.clear();
+    }
+
+    fn get(&mut self, handle: &image::Handle) -> Option<&mut Memory> {
+        let _ = self.hits.insert(handle.id());
+
+        self.map.get_mut(&handle.id())
+    }
+
+    fn insert(&mut self, handle: &image::Handle, memory: Memory) {
+        let _ = self.map.insert(handle.id(), memory);
+    }
+
+    fn contains(&self, handle: &image::Handle) -> bool {
+        self.map.contains_key(&handle.id())
+    }
+}
diff --git a/wgpu/src/image/vector.rs b/wgpu/src/image/vector.rs
new file mode 100644
index 00000000..aa712372
--- /dev/null
+++ b/wgpu/src/image/vector.rs
@@ -0,0 +1,192 @@
+use iced_native::svg;
+use std::{
+    collections::{HashMap, HashSet},
+    rc::Rc,
+};
+
+pub enum Svg {
+    Loaded { tree: resvg::usvg::Tree },
+    NotFound,
+}
+
+impl Svg {
+    pub fn viewport_dimensions(&self) -> (u32, u32) {
+        match self {
+            Svg::Loaded { tree } => {
+                let size = tree.svg_node().size;
+
+                (size.width() as u32, size.height() as u32)
+            }
+            Svg::NotFound => (1, 1),
+        }
+    }
+}
+
+impl std::fmt::Debug for Svg {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "Svg")
+    }
+}
+
+#[derive(Debug)]
+pub struct Cache {
+    svgs: HashMap<u64, Svg>,
+    rasterized: HashMap<(u64, u32, u32), Rc<wgpu::BindGroup>>,
+    svg_hits: HashSet<u64>,
+    rasterized_hits: HashSet<(u64, u32, u32)>,
+}
+
+impl Cache {
+    pub fn new() -> Self {
+        Self {
+            svgs: HashMap::new(),
+            rasterized: HashMap::new(),
+            svg_hits: HashSet::new(),
+            rasterized_hits: HashSet::new(),
+        }
+    }
+
+    pub fn load(&mut self, handle: &svg::Handle) -> &Svg {
+        if self.svgs.contains_key(&handle.id()) {
+            return self.svgs.get(&handle.id()).unwrap();
+        }
+
+        let opt = resvg::Options::default();
+
+        let svg = match resvg::usvg::Tree::from_file(handle.path(), &opt.usvg) {
+            Ok(tree) => Svg::Loaded { tree },
+            Err(_) => Svg::NotFound,
+        };
+
+        let _ = self.svgs.insert(handle.id(), svg);
+        self.svgs.get(&handle.id()).unwrap()
+    }
+
+    pub fn upload(
+        &mut self,
+        handle: &svg::Handle,
+        [width, height]: [f32; 2],
+        scale: f32,
+        device: &wgpu::Device,
+        encoder: &mut wgpu::CommandEncoder,
+        texture_layout: &wgpu::BindGroupLayout,
+    ) -> Option<Rc<wgpu::BindGroup>> {
+        let id = handle.id();
+
+        let (width, height) = (
+            (scale * width).round() as u32,
+            (scale * height).round() as u32,
+        );
+
+        // TODO: Optimize!
+        // We currently rerasterize the SVG when its size changes. This is slow
+        // as heck. A GPU rasterizer like `pathfinder` may perform better.
+        // It would be cool to be able to smooth resize the `svg` example.
+        if let Some(bind_group) = self.rasterized.get(&(id, width, height)) {
+            let _ = self.svg_hits.insert(id);
+            let _ = self.rasterized_hits.insert((id, width, height));
+
+            return Some(bind_group.clone());
+        }
+
+        match self.load(handle) {
+            Svg::Loaded { tree } => {
+                let extent = wgpu::Extent3d {
+                    width,
+                    height,
+                    depth: 1,
+                };
+
+                let texture = device.create_texture(&wgpu::TextureDescriptor {
+                    size: extent,
+                    array_layer_count: 1,
+                    mip_level_count: 1,
+                    sample_count: 1,
+                    dimension: wgpu::TextureDimension::D2,
+                    format: wgpu::TextureFormat::Bgra8UnormSrgb,
+                    usage: wgpu::TextureUsage::COPY_DST
+                        | wgpu::TextureUsage::SAMPLED,
+                });
+
+                let temp_buf = {
+                    let screen_size =
+                        resvg::ScreenSize::new(width, height).unwrap();
+
+                    let mut canvas = resvg::raqote::DrawTarget::new(
+                        width as i32,
+                        height as i32,
+                    );
+
+                    resvg::backend_raqote::render_to_canvas(
+                        &tree,
+                        &resvg::Options::default(),
+                        screen_size,
+                        &mut canvas,
+                    );
+
+                    let slice = canvas.get_data();
+
+                    device
+                        .create_buffer_mapped(
+                            slice.len(),
+                            wgpu::BufferUsage::COPY_SRC,
+                        )
+                        .fill_from_slice(slice)
+                };
+
+                encoder.copy_buffer_to_texture(
+                    wgpu::BufferCopyView {
+                        buffer: &temp_buf,
+                        offset: 0,
+                        row_pitch: 4 * width as u32,
+                        image_height: height as u32,
+                    },
+                    wgpu::TextureCopyView {
+                        texture: &texture,
+                        array_layer: 0,
+                        mip_level: 0,
+                        origin: wgpu::Origin3d {
+                            x: 0.0,
+                            y: 0.0,
+                            z: 0.0,
+                        },
+                    },
+                    extent,
+                );
+
+                let bind_group =
+                    device.create_bind_group(&wgpu::BindGroupDescriptor {
+                        layout: texture_layout,
+                        bindings: &[wgpu::Binding {
+                            binding: 0,
+                            resource: wgpu::BindingResource::TextureView(
+                                &texture.create_default_view(),
+                            ),
+                        }],
+                    });
+
+                let bind_group = Rc::new(bind_group);
+
+                let _ = self
+                    .rasterized
+                    .insert((id, width, height), bind_group.clone());
+
+                let _ = self.svg_hits.insert(id);
+                let _ = self.rasterized_hits.insert((id, width, height));
+
+                Some(bind_group)
+            }
+            Svg::NotFound => None,
+        }
+    }
+
+    pub fn trim(&mut self) {
+        let svg_hits = &self.svg_hits;
+        let rasterized_hits = &self.rasterized_hits;
+
+        self.svgs.retain(|k, _| svg_hits.contains(k));
+        self.rasterized.retain(|k, _| rasterized_hits.contains(k));
+        self.svg_hits.clear();
+        self.rasterized_hits.clear();
+    }
+}
diff --git a/wgpu/src/primitive.rs b/wgpu/src/primitive.rs
index 04264e5d..958cc17f 100644
--- a/wgpu/src/primitive.rs
+++ b/wgpu/src/primitive.rs
@@ -1,6 +1,6 @@
 use iced_native::{
-    image, Background, Color, Font, HorizontalAlignment, Rectangle, Vector,
-    VerticalAlignment,
+    image, svg, Background, Color, Font, HorizontalAlignment, Rectangle,
+    Vector, VerticalAlignment,
 };
 
 /// A rendering primitive.
@@ -46,6 +46,14 @@ pub enum Primitive {
         /// The bounds of the image
         bounds: Rectangle,
     },
+    /// An SVG primitive
+    Svg {
+        /// The path of the SVG file
+        handle: svg::Handle,
+
+        /// The bounds of the viewport
+        bounds: Rectangle,
+    },
     /// A clip primitive
     Clip {
         /// The bounds of the clip
diff --git a/wgpu/src/renderer.rs b/wgpu/src/renderer.rs
index fa52bd96..365ef1ef 100644
--- a/wgpu/src/renderer.rs
+++ b/wgpu/src/renderer.rs
@@ -1,4 +1,4 @@
-use crate::{quad, text, Image, Primitive, Quad, Transformation};
+use crate::{image, quad, text, Image, Primitive, Quad, Transformation};
 use iced_native::{
     renderer::{Debugger, Windowed},
     Background, Color, Layout, MouseCursor, Point, Rectangle, Vector, Widget,
@@ -232,7 +232,14 @@ impl Renderer {
             }
             Primitive::Image { handle, bounds } => {
                 layer.images.push(Image {
-                    handle: handle.clone(),
+                    handle: image::Handle::Raster(handle.clone()),
+                    position: [bounds.x, bounds.y],
+                    scale: [bounds.width, bounds.height],
+                });
+            }
+            Primitive::Svg { handle, bounds } => {
+                layer.images.push(Image {
+                    handle: image::Handle::Vector(handle.clone()),
                     position: [bounds.x, bounds.y],
                     scale: [bounds.width, bounds.height],
                 });
@@ -342,6 +349,7 @@ impl Renderer {
                 translated_and_scaled,
                 bounds,
                 target,
+                dpi,
             );
         }
 
diff --git a/wgpu/src/renderer/widget.rs b/wgpu/src/renderer/widget.rs
index 52410bee..91f107e8 100644
--- a/wgpu/src/renderer/widget.rs
+++ b/wgpu/src/renderer/widget.rs
@@ -8,3 +8,6 @@ mod scrollable;
 mod slider;
 mod text;
 mod text_input;
+
+#[cfg(feature = "svg")]
+mod svg;
diff --git a/wgpu/src/renderer/widget/svg.rs b/wgpu/src/renderer/widget/svg.rs
new file mode 100644
index 00000000..67bc3fe1
--- /dev/null
+++ b/wgpu/src/renderer/widget/svg.rs
@@ -0,0 +1,22 @@
+use crate::{Primitive, Renderer};
+use iced_native::{svg, Layout, MouseCursor};
+
+impl svg::Renderer for Renderer {
+    fn dimensions(&self, handle: &svg::Handle) -> (u32, u32) {
+        self.image_pipeline.viewport_dimensions(handle)
+    }
+
+    fn draw(
+        &mut self,
+        handle: svg::Handle,
+        layout: Layout<'_>,
+    ) -> Self::Output {
+        (
+            Primitive::Svg {
+                handle,
+                bounds: layout.bounds(),
+            },
+            MouseCursor::OutOfBounds,
+        )
+    }
+}
diff --git a/wgpu/src/text/font.rs b/wgpu/src/text/font.rs
index 31df5bf4..7346ccdb 100644
--- a/wgpu/src/text/font.rs
+++ b/wgpu/src/text/font.rs
@@ -1,5 +1,6 @@
-pub use font_kit::error::SelectionError as LoadError;
-pub use font_kit::family_name::FamilyName as Family;
+pub use font_kit::{
+    error::SelectionError as LoadError, family_name::FamilyName as Family,
+};
 
 pub struct Source {
     raw: font_kit::source::SystemSource,