egui_minipng/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
use egui::{
    ahash::HashMap,
    load::{Bytes, BytesPoll, ImageLoadResult, ImageLoader, ImagePoll, LoadError, SizeHint},
    mutex::Mutex,
    ColorImage, Context,
};
use std::{mem::size_of, path::Path, sync::Arc};

type Entry = Result<Arc<ColorImage>, String>;

#[derive(Default)]
pub struct PngLoader {
    cache: Mutex<HashMap<String, Entry>>,
}

impl PngLoader {
    pub const ID: &'static str = egui::generate_loader_id!(PngLoader);
}

fn is_supported_uri(uri: &str) -> bool {
    let Some(ext) = Path::new(uri).extension().and_then(|ext| ext.to_str()) else {
        return false;
    };

    ext == "png"
}

fn is_unsupported_mime(mime: &str) -> bool {
    !mime.contains("png")
}

fn load_image_bytes(header: &minipng::ImageHeader, bytes: &Bytes) -> Result<ColorImage, minipng::Error> {
    let mut buffer = vec![0; header.required_bytes_rgba8bpc()];
    let mut image = minipng::decode_png(bytes, &mut buffer)?;
    image.convert_to_rgba8bpc()?;

    let size = [image.width() as _, image.height() as _];
    let pixels = image.pixels();
    Ok(ColorImage::from_rgba_unmultiplied(size, pixels))
}

impl ImageLoader for PngLoader {
    fn id(&self) -> &str {
        Self::ID
    }

    fn load(&self, ctx: &egui::Context, uri: &str, _: SizeHint) -> ImageLoadResult {
        if !is_supported_uri(uri) {
            return Err(LoadError::NotSupported);
        }

        let mut cache = self.cache.lock();
        if let Some(entry) = cache.get(uri).cloned() {
            match entry {
                Ok(image) => Ok(ImagePoll::Ready { image }),
                Err(err) => Err(LoadError::Loading(err)),
            }
        } else {
            match ctx.try_load_bytes(uri) {
                Ok(BytesPoll::Ready { bytes, mime, .. }) => {
                    if mime.as_deref().is_some_and(is_unsupported_mime) {
                        return Err(LoadError::NotSupported);
                    }

                    let Ok(header) = minipng::decode_png_header(&bytes) else {
                        return Err(LoadError::NotSupported);
                    };

                    let result = load_image_bytes(&header, &bytes).map(Arc::new).map_err(|e| e.to_string());
                    cache.insert(uri.into(), result.clone());
                    match result {
                        Ok(image) => Ok(ImagePoll::Ready { image }),
                        Err(err) => Err(LoadError::Loading(err)),
                    }
                }
                Ok(BytesPoll::Pending { size }) => Ok(ImagePoll::Pending { size }),
                Err(err) => Err(err),
            }
        }
    }

    fn forget(&self, uri: &str) {
        let _ = self.cache.lock().remove(uri);
    }

    fn forget_all(&self) {
        self.cache.lock().clear();
    }

    fn byte_size(&self) -> usize {
        self.cache
            .lock()
            .values()
            .map(|result| match result {
                Ok(image) => image.pixels.len() * size_of::<egui::Color32>(),
                Err(err) => err.len(),
            })
            .sum()
    }
}

/// Installs the minipng image loader.
pub fn install(context: &Context) {
    context.add_image_loader(Arc::new(PngLoader::default()))
}