iced_webview/
lib.rs

1//! A library to embed web views in iced applications.
2//!
3//! Supports [Blitz](https://github.com/DioxusLabs/blitz) (Rust-native, modern CSS),
4//! [litehtml](https://github.com/franzos/litehtml-rs) (lightweight, CPU-based), and
5//! [Servo](https://servo.org/) (full browser: HTML5, CSS3, JS).
6//!
7//! Has two separate widgets: Basic, and Advanced.
8//! The basic widget is simple to implement — use abstractions like `CloseCurrent` and `ChangeView`.
9//! The advanced widget gives you direct `ViewId` control for multiple simultaneous views.
10//!
11//! # Basic usage
12//!
13//! ```rust,ignore
14//! enum Message {
15//!    WebView(iced_webview::Action),
16//!    Update,
17//! }
18//!
19//! struct State {
20//!    webview: iced_webview::WebView<iced_webview::Blitz, Message>,
21//! }
22//! ```
23//!
24//! Then call the usual `view/update` methods — see
25//! [examples](https://github.com/franzos/iced_webview_v2/tree/main/examples) for full working code.
26//!
27use std::sync::Arc;
28
29use iced::widget::image;
30
31/// Engine Trait and Engine implementations
32pub mod engines;
33pub use engines::{Engine, PageType, PixelFormat, ViewId};
34
35mod webview;
36pub use basic::{Action, WebView};
37pub use webview::{advanced, basic};
38
39#[cfg(feature = "blitz")]
40pub use engines::blitz::Blitz;
41
42#[cfg(feature = "litehtml")]
43pub use engines::litehtml::Litehtml;
44
45#[cfg(feature = "servo")]
46pub use engines::servo::Servo;
47
48#[cfg(feature = "cef")]
49pub use engines::cef_engine::{cef_subprocess_check, Cef};
50
51pub(crate) mod util;
52
53#[cfg(any(feature = "litehtml", feature = "blitz"))]
54pub(crate) mod fetch;
55
56/// Image details for passing the view around
57#[derive(Clone, Debug)]
58pub struct ImageInfo {
59    width: u32,
60    height: u32,
61    handle: image::Handle,
62    raw_pixels: Arc<Vec<u8>>,
63}
64
65impl Default for ImageInfo {
66    fn default() -> Self {
67        Self::blank(Self::WIDTH, Self::HEIGHT)
68    }
69}
70
71impl ImageInfo {
72    // The default dimensions
73    const WIDTH: u32 = 800;
74    const HEIGHT: u32 = 800;
75
76    #[allow(dead_code)]
77    fn new(mut pixels: Vec<u8>, format: PixelFormat, width: u32, height: u32) -> Self {
78        // R, G, B, A
79        assert_eq!(pixels.len() % 4, 0);
80
81        if let PixelFormat::Bgra = format {
82            pixels.chunks_mut(4).for_each(|chunk| chunk.swap(0, 2));
83        }
84
85        let raw_pixels = Arc::new(pixels);
86        Self {
87            width,
88            height,
89            handle: image::Handle::from_rgba(width, height, (*raw_pixels).clone()),
90            raw_pixels,
91        }
92    }
93
94    /// Construct an `ImageInfo` for the shader-widget rendering path,
95    /// skipping the `image::Handle` allocation. Saves a viewport-sized
96    /// clone per frame for engines that never read `handle`.
97    #[allow(dead_code)]
98    pub(crate) fn from_shader_pixels(pixels: Vec<u8>, width: u32, height: u32) -> Self {
99        debug_assert_eq!(pixels.len() % 4, 0);
100        Self {
101            width,
102            height,
103            // 1×1 placeholder; the shader widget path doesn't read this.
104            handle: image::Handle::from_rgba(1, 1, vec![0u8; 4]),
105            raw_pixels: Arc::new(pixels),
106        }
107    }
108
109    /// Get the image handle for direct rendering.
110    pub fn as_handle(&self) -> image::Handle {
111        self.handle.clone()
112    }
113
114    /// Image width.
115    pub fn image_width(&self) -> u32 {
116        self.width
117    }
118
119    /// Image height.
120    pub fn image_height(&self) -> u32 {
121        self.height
122    }
123
124    /// Raw RGBA pixel data for direct GPU upload (shader widget path).
125    pub fn pixels(&self) -> Arc<Vec<u8>> {
126        Arc::clone(&self.raw_pixels)
127    }
128
129    fn blank(width: u32, height: u32) -> Self {
130        let (w, h) = (width as usize)
131            .checked_mul(height as usize)
132            .and_then(|n| n.checked_mul(4))
133            .map_or((1u32, 1u32), |_| (width, height));
134
135        let pixels = vec![255; (w as usize * h as usize) * 4];
136        let raw_pixels = Arc::new(pixels.clone());
137        Self {
138            width: w,
139            height: h,
140            handle: image::Handle::from_rgba(w, h, pixels),
141            raw_pixels,
142        }
143    }
144}
iced_webview/lib.rs

iced_webview/
lib.rs
