Use the more explicit egui_extras::install_image_loaders

crates/egui/src/load.rs

@@ -4,7 +4,7 @@
 //! will get you up and running quickly with its reasonable default implementations of the traits described below.
 //!
 //! 1. Add [`egui_extras`](https://crates.io/crates/egui_extras/) as a dependency with the `all_loaders` feature.
-//! 2. Add a call to [`egui_extras::loaders::install`](https://docs.rs/egui_extras/latest/egui_extras/loaders/fn.install.html)
+//! 2. Add a call to [`egui_extras::install_image_loaders`](https://docs.rs/egui_extras/latest/egui_extras/loaders/fn.install.html)
 //!    in your app's setup code.
 //! 3. Use [`Ui::image`][`crate::ui::Ui::image`] with some [`ImageSource`][`crate::ImageSource`].
 //!

crates/egui/src/ui.rs

@@ -1561,7 +1561,7 @@ impl Ui {
     /// Show an image available at the given `uri`.
     ///
     /// ⚠ This will do nothing unless you install some image loaders first!
-    /// The easiest way to do this is via [`egui_extras::loaders::install`](https://docs.rs/egui_extras/latest/egui_extras/loaders/fn.install.html).
+    /// The easiest way to do this is via [`egui_extras::install_image_loaders`](https://docs.rs/egui_extras/latest/egui_extras/loaders/fn.install.html).
     ///
     /// The loaders handle caching image data, sampled textures, etc. across frames, so calling this is immediate-mode safe.
     ///

crates/egui_demo_app/src/wrap_app.rs

@@ -165,7 +165,7 @@ pub struct WrapApp {
 
 impl WrapApp {
     pub fn new(_cc: &eframe::CreationContext<'_>) -> Self {
-        egui_extras::loaders::install(&_cc.egui_ctx);
+        egui_extras::install_image_loaders(&_cc.egui_ctx);
 
         #[allow(unused_mut)]
         let mut slf = Self {

crates/egui_extras/Cargo.toml

@@ -38,6 +38,14 @@ file = ["dep:mime_guess"]
 ## Add support for loading images via HTTP.
 http = ["dep:ehttp"]
 
+## Add support for loading images with the [`image`](https://docs.rs/image) crate.
+##
+## You also need to ALSO opt-in to the image formats you want to support, like so:
+## ```toml
+## image = { version = "0.24", features = ["jpeg", "png"] }
+## ```
+image = ["dep:image"]
+
 ## Enable profiling with the [`puffin`](https://docs.rs/puffin) crate.
 ##
 ## Only enabled on native, because of the low resolution (1ms) of clocks in browsers.
@@ -71,12 +79,6 @@ chrono = { version = "0.4", optional = true, default-features = false, features
 ## Enable this when generating docs.
 document-features = { version = "0.2", optional = true }
 
-## Add support for loading images with the [`image`](https://docs.rs/image) crate.
-##
-## You also need to ALSO opt-in to the image formats you want to support, like so:
-## ```toml
-## image = { version = "0.24", features = ["jpeg", "png"] }
-## ```
 image = { version = "0.24", optional = true, default-features = false }
 
 # file feature

crates/egui_extras/src/lib.rs

@@ -34,6 +34,8 @@ pub use crate::sizing::Size;
 pub use crate::strip::*;
 pub use crate::table::*;
 
+pub use loaders::install_image_loaders;
+
 // ---------------------------------------------------------------------------
 
 mod profiling_scopes {

crates/egui_extras/src/loaders.rs

@@ -1,17 +1,19 @@
 // TODO: automatic cache eviction
 
-/// Installs the default set of loaders.
+/// Installs a set of image loaders.
 ///
-/// - `file` loader on non-Wasm targets
-/// - `http` loader (with the `http` feature)
-/// - `image` loader (with the `image` feature)
-/// - `svg` loader with the `svg` feature
+/// Calling this enables the use of [`egui::Image`] and [`egui::Ui::image`].
+///
+/// ⚠ This will do nothing and you won't see any images unless you also enable some feature flags on `egui_extras`:
+///
+/// - `file` feature: `file://` loader on non-Wasm targets
+/// - `http` feature: `http(s)://` loader
+/// - `image` feature: Loader of png, jpeg etc using the [`image`] crate
+/// - `svg` feature: `.svg` loader
 ///
 /// Calling this multiple times on the same [`egui::Context`] is safe.
 /// It will never install duplicate loaders.
 ///
-/// ⚠ This will do nothing and you won't see any images unless you enable some features:
-///
 /// - If you just want to be able to load `file://` and `http://` URIs, enable the `all_loaders` feature.
 /// - The supported set of image formats is configured by adding the [`image`](https://crates.io/crates/image)
 /// crate as your direct dependency, and enabling features on it:
@@ -40,7 +42,8 @@
 /// It will attempt to load `http://` and `https://` URIs, and infer the content type from the `Content-Type` header.
 ///
 /// The `image` loader is an [`ImageLoader`][`egui::load::ImageLoader`].
-/// It will attempt to load any URI with any extension other than `svg`. It will also load any URI without an extension.
+/// It will attempt to load any URI with any extension other than `svg`.
+/// It will also try to load any URI without an extension.
 /// The content type specified by [`BytesPoll::Ready::mime`][`egui::load::BytesPoll::Ready::mime`] always takes precedence.
 /// This means that even if the URI has a `png` extension, and the `png` image format is enabled, if the content type is
 /// not one of the supported and enabled image formats, the loader will return [`LoadError::NotSupported`][`egui::load::LoadError::NotSupported`],
@@ -52,7 +55,7 @@
 /// and must include `svg` for it to be considered supported. For example, `image/svg+xml` would be loaded by the `svg` loader.
 ///
 /// See [`egui::load`] for more information about how loaders work.
-pub fn install(ctx: &egui::Context) {
+pub fn install_image_loaders(ctx: &egui::Context) {
     #[cfg(all(not(target_arch = "wasm32"), feature = "file"))]
     if !ctx.is_loader_installed(self::file_loader::FileLoader::ID) {
         ctx.add_bytes_loader(std::sync::Arc::new(self::file_loader::FileLoader::default()));
@@ -87,7 +90,7 @@ pub fn install(ctx: &egui::Context) {
         not(feature = "image"),
         not(feature = "svg")
     ))]
-    log::warn!("`loaders::install` was called, but no loaders are enabled");
+    log::warn!("`install_image_loaders` was called, but no loaders are enabled");
 
     let _ = ctx;
 }

examples/images/src/main.rs

@@ -13,7 +13,7 @@ fn main() -> Result<(), eframe::Error> {
         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);
+            egui_extras::install_image_loaders(&cc.egui_ctx);
             Box::<MyApp>::default()
         }),
     )