Improved texture loading (#3315)

* rework loading around `Arc<Loaders>` * use `Bytes` instead of splitting api * remove unwraps in `texture_handle` * make `FileLoader` optional under `file` feature * hide http load error stack trace from UI * implement image fit * support more image sources * center spinner if we know size ahead of time * allocate final size for spinner * improve image format guessing * remove `ui.image`, `Image`, add `RawImage` * deprecate `RetainedImage` * `image2` -> `image` * add viewer example * update `examples/image` + remove `svg` and `download_image` exapmles * fix lints and tests * fix doc link * add image controls to `images` example * add more `From` str-like types * add api to forget all images * fix max size * do not scale original size unless necessary * fix doc link * add more docs for `Image` and `RawImage` * make paint_at `pub` * update `ImageButton` to use new `Image` API * fix double rendering * `SizeHint::Original` -> `Scale` + remove `Option` wrapper * Update crates/egui/src/load.rs Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com> * remove special `None` value for `forget` * Update crates/egui/src/load.rs Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com> * add more examples to `ui.image` + add `include_image` macro * Update crates/egui/src/ui.rs Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com> * update `menu_image_button` to use `ImageSource` * `OrderedFloat::get` -> `into_inner` * derive `Eq` on `SizedTexture` * add `id` to loaders + `is_installed` check * move `images` to demo + simplify `images` example * log trace when installing loaders * fix lint * fix doc link * add more documentation * more `egui_extras::loaders` docs * Update examples/images/src/main.rs Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com> * update `images` example screenshots + readme * remove unused `rfd` from `images` example * Update crates/egui_extras/src/loaders/ehttp_loader.rs Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com> * add `must_use` on `Image` and `RawImage` * document `loaders::install` multiple call safety * Update crates/egui_extras/Cargo.toml Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com> * reshuffle `is_loader_installed` * make `include_image` produce `ImageSource` + update docs * update `include_image` docs * remove `None` mentions from loader `forget` * inline `From` texture id + size for `SizedTexture` * add warning about statically known path * change image load error + use in image button * add `.size()` to `Image` * Update crates/egui_demo_app/Cargo.toml Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com> * add explanations to image viewer ui --------- Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
2026-06-26 22:53:14 -04:00 · 2023-09-12 10:39:17 +02:00
parent dbcf15b49e
commit 2bc6814acc
47 changed files with 1563 additions and 770 deletions
--- a/examples/download_image/README.md
+++ b/examples/download_image/README.md
@@ -1,7 +0,0 @@
-Example how to download and show an image with eframe/egui.
-
-```sh
-cargo run -p download_image
-```
-
-![](screenshot.png)
--- a/examples/download_image/screenshot.png
+++ b/examples/download_image/screenshot.png
--- a/examples/download_image/src/main.rs
+++ b/examples/download_image/src/main.rs
@@ -1,41 +0,0 @@
-#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
-
-use eframe::egui;
-
-fn main() -> Result<(), eframe::Error> {
-    env_logger::init(); // Log to stderr (if you run with `RUST_LOG=debug`).
-    let options = eframe::NativeOptions::default();
-    eframe::run_native(
-        "Download and show an image with eframe/egui",
-        options,
-        Box::new(|cc| {
-            // Without the following call, the `Image2` created below
-            // will simply output `not supported` error messages.
-            egui_extras::loaders::install(&cc.egui_ctx);
-            Box::new(MyApp)
-        }),
-    )
-}
-
-#[derive(Default)]
-struct MyApp;
-
-impl eframe::App for MyApp {
-    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        egui::CentralPanel::default().show(ctx, |ui| {
-            let width = ui.available_width();
-            let half_height = ui.available_height() / 2.0;
-
-            ui.allocate_ui(egui::Vec2::new(width, half_height), |ui| {
-                ui.add(egui::Image2::from_uri(
-                    "https://picsum.photos/seed/1.759706314/1024",
-                ))
-            });
-            ui.allocate_ui(egui::Vec2::new(width, half_height), |ui| {
-                ui.add(egui::Image2::from_uri(
-                    "https://this-is-hopefully-not-a-real-website.rs/image.png",
-                ))
-            });
-        });
-    }
-}
--- a/examples/download_image/Cargo.toml
+++ b/examples/download_image/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
-name = "download_image"
+name = "images"
 version = "0.1.0"
-authors = ["Emil Ernerfeldt <emil.ernerfeldt@gmail.com>"]
+authors = ["Jan Procházka <github.com/jprochazk>"]
 license = "MIT OR Apache-2.0"
 edition = "2021"
 rust-version = "1.70"
@@ -10,12 +10,14 @@ publish = false

 [dependencies]
 eframe = { path = "../../crates/eframe", features = [
-    "__screenshot", # __screenshot is so we can dump a screenshot using EFRAME_SCREENSHOT_TO
+  "__screenshot", # __screenshot is so we can dump a screenshot using EFRAME_SCREENSHOT_TO
 ] }
 egui_extras = { path = "../../crates/egui_extras", features = [
-    "http",
-    "image",
-    "log",
+  "all-loaders",
+  "log",
 ] }
 env_logger = "0.10"
-image = { version = "0.24", default-features = false, features = ["jpeg"] }
+image = { version = "0.24", default-features = false, features = [
+  "jpeg",
+  "png",
+] }
--- a/examples/images/README.md
+++ b/examples/images/README.md
@@ -0,0 +1,7 @@
+Example showing how to show images with eframe/egui.
+
+```sh
+cargo run -p images
+```
+
+![](screenshot.png)
--- a/examples/images/screenshot.png
+++ b/examples/images/screenshot.png
--- a/examples/svg/src/rustacean-flat-happy.svg
+++ b/examples/svg/src/rustacean-flat-happy.svg
--- a/examples/images/src/main.rs
+++ b/examples/images/src/main.rs
@@ -0,0 +1,41 @@
+#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
+
+use eframe::egui;
+use eframe::epaint::vec2;
+
+fn main() -> Result<(), eframe::Error> {
+    env_logger::init(); // Log to stderr (if you run with `RUST_LOG=debug`).
+    let options = eframe::NativeOptions {
+        drag_and_drop_support: true,
+        ..Default::default()
+    };
+    eframe::run_native(
+        "Image Viewer",
+        options,
+        Box::new(|cc| {
+            // The following call is needed to load images when using `ui.image` and `egui::Image`:
+            egui_extras::loaders::install(&cc.egui_ctx);
+            Box::<MyApp>::default()
+        }),
+    )
+}
+
+#[derive(Default)]
+struct MyApp {}
+
+impl eframe::App for MyApp {
+    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
+        egui::CentralPanel::default().show(ctx, |ui| {
+            egui::ScrollArea::new([true, true]).show(ui, |ui| {
+                ui.add(
+                    egui::Image::new(egui::include_image!("ferris.svg"))
+                        .fit_to_fraction(vec2(1.0, 0.5)),
+                );
+                ui.add(
+                    egui::Image::new("https://picsum.photos/seed/1.759706314/1024".into())
+                        .rounding(egui::Rounding::same(10.0)),
+                );
+            });
+        });
+    }
+}
--- a/examples/retained_image/Cargo.toml
+++ b/examples/retained_image/Cargo.toml
@@ -1,17 +0,0 @@
-[package]
-name = "retained_image"
-version = "0.1.0"
-authors = ["Emil Ernerfeldt <emil.ernerfeldt@gmail.com>"]
-license = "MIT OR Apache-2.0"
-edition = "2021"
-rust-version = "1.70"
-publish = false
-
-
-[dependencies]
-eframe = { path = "../../crates/eframe", features = [
-    "__screenshot", # __screenshot is so we can dump a screenshot using EFRAME_SCREENSHOT_TO
-] }
-egui_extras = { path = "../../crates/egui_extras", features = ["image", "log"] }
-env_logger = "0.10"
-image = { version = "0.24", default-features = false, features = ["png"] }
--- a/examples/retained_image/README.md
+++ b/examples/retained_image/README.md
@@ -1,7 +0,0 @@
-Example how to show an image with eframe/egui.
-
-```sh
-cargo run -p retained_image
-```
-
-![](screenshot.png)
--- a/examples/retained_image/screenshot.png
+++ b/examples/retained_image/screenshot.png
--- a/examples/retained_image/src/crab.png
+++ b/examples/retained_image/src/crab.png
--- a/examples/retained_image/src/main.rs
+++ b/examples/retained_image/src/main.rs
@@ -1,84 +0,0 @@
-#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
-
-use eframe::egui;
-use egui_extras::RetainedImage;
-
-fn main() -> Result<(), eframe::Error> {
-    env_logger::init(); // Log to stderr (if you run with `RUST_LOG=debug`).
-    let options = eframe::NativeOptions {
-        initial_window_size: Some(egui::vec2(400.0, 1000.0)),
-        ..Default::default()
-    };
-    eframe::run_native(
-        "Show an image with eframe/egui",
-        options,
-        Box::new(|_cc| Box::<MyApp>::default()),
-    )
-}
-
-struct MyApp {
-    image: RetainedImage,
-    rounding: f32,
-    tint: egui::Color32,
-}
-
-impl Default for MyApp {
-    fn default() -> Self {
-        Self {
-            // crab image is CC0, found on https://stocksnap.io/search/crab
-            image: RetainedImage::from_image_bytes("crab.png", include_bytes!("crab.png")).unwrap(),
-            rounding: 32.0,
-            tint: egui::Color32::from_rgb(100, 200, 200),
-        }
-    }
-}
-
-impl eframe::App for MyApp {
-    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        let Self {
-            image,
-            rounding,
-            tint,
-        } = self;
-
-        egui::CentralPanel::default().show(ctx, |ui| {
-            ui.heading("This is an image:");
-            image.show(ui);
-
-            ui.add_space(32.0);
-
-            ui.heading("This is a tinted image with rounded corners:");
-            ui.add(
-                egui::Image::new(image.texture_id(ctx), image.size_vec2())
-                    .tint(*tint)
-                    .rounding(*rounding),
-            );
-
-            ui.horizontal(|ui| {
-                ui.label("Tint:");
-                egui::color_picker::color_edit_button_srgba(
-                    ui,
-                    tint,
-                    egui::color_picker::Alpha::BlendOrAdditive,
-                );
-
-                ui.add_space(16.0);
-
-                ui.label("Rounding:");
-                ui.add(
-                    egui::DragValue::new(rounding)
-                        .speed(1.0)
-                        .clamp_range(0.0..=0.5 * image.size_vec2().min_elem()),
-                );
-            });
-
-            ui.add_space(32.0);
-
-            ui.heading("This is an image you can click:");
-            ui.add(egui::ImageButton::new(
-                image.texture_id(ctx),
-                image.size_vec2(),
-            ));
-        });
-    }
-}
--- a/examples/screenshot/src/main.rs
+++ b/examples/screenshot/src/main.rs
@@ -63,7 +63,7 @@ impl eframe::App for MyApp {
            });

            if let Some(texture) = self.texture.as_ref() {
-                ui.image(texture, ui.available_size());
+                ui.raw_image((texture.id(), ui.available_size()));
            } else {
                ui.spinner();
            }
--- a/examples/svg/Cargo.toml
+++ b/examples/svg/Cargo.toml
@@ -1,16 +0,0 @@
-[package]
-name = "svg"
-version = "0.1.0"
-authors = ["Emil Ernerfeldt <emil.ernerfeldt@gmail.com>"]
-license = "MIT OR Apache-2.0"
-edition = "2021"
-rust-version = "1.70"
-publish = false
-
-
-[dependencies]
-eframe = { path = "../../crates/eframe", features = [
-    "__screenshot", # __screenshot is so we can dump a screenshot using EFRAME_SCREENSHOT_TO
-] }
-egui_extras = { path = "../../crates/egui_extras", features = ["log", "svg"] }
-env_logger = "0.10"
--- a/examples/svg/README.md
+++ b/examples/svg/README.md
@@ -1,7 +0,0 @@
-Example how to show an SVG image.
-
-```sh
-cargo run -p svg
-```
-
-![](screenshot.png)
--- a/examples/svg/screenshot.png
+++ b/examples/svg/screenshot.png
--- a/examples/svg/src/main.rs
+++ b/examples/svg/src/main.rs
@@ -1,47 +0,0 @@
-//! A good way of displaying an SVG image in egui.
-//!
-//! Requires the dependency `egui_extras` with the `svg` feature.
-
-#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
-
-use eframe::egui;
-
-fn main() -> Result<(), eframe::Error> {
-    env_logger::init(); // Log to stderr (if you run with `RUST_LOG=debug`).
-    let options = eframe::NativeOptions {
-        initial_window_size: Some(egui::vec2(1000.0, 700.0)),
-        ..Default::default()
-    };
-    eframe::run_native(
-        "svg example",
-        options,
-        Box::new(|cc| {
-            // Without the following call, the `Image2` created below
-            // will simply output a `not supported` error message.
-            egui_extras::loaders::install(&cc.egui_ctx);
-            Box::new(MyApp)
-        }),
-    )
-}
-
-struct MyApp;
-
-impl eframe::App for MyApp {
-    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        egui::CentralPanel::default().show(ctx, |ui| {
-            ui.heading("SVG example");
-            ui.label("The SVG is rasterized and displayed as a texture.");
-
-            ui.separator();
-
-            let max_size = ui.available_size();
-            ui.add(
-                egui::Image2::from_static_bytes(
-                    "ferris.svg",
-                    include_bytes!("rustacean-flat-happy.svg"),
-                )
-                .size_hint(max_size),
-            );
-        });
-    }
-}
--- a/examples/svg/src/rust-logo-license.txt
+++ b/examples/svg/src/rust-logo-license.txt
@@ -1 +0,0 @@
-Rust logo by Mozilla, from https://github.com/rust-lang/rust-artwork
				`@@ -1 +0,0 @@`
				`Rust logo by Mozilla, from https://github.com/rust-lang/rust-artwork`