5b0e6a5321
# Objective Fixes #9121 Context: - `ImageTextureLoader` depends on `RenderDevice` to work out which compressed image formats it can support - `RenderDevice` is initialised by `RenderPlugin` - https://github.com/bevyengine/bevy/pull/8336 made `RenderPlugin` initialisation async - This caused `RenderDevice` to be missing at the time of `ImageTextureLoader` initialisation, which in turn meant UASTC encoded ktx2 textures were being converted to unsupported formats, and thus caused panics ## Solution - Delay `ImageTextureLoader` initialisation --- ## Changelog - Moved `ImageTextureLoader` initialisation from `ImagePlugin::build()` to `ImagePlugin::finish()` - Default to `CompressedImageFormats::NONE` if `RenderDevice` resource is missing --------- Co-authored-by: 66OJ66 <hi0obxud@anonaddy.me>
108 lines
2.7 KiB
Rust
108 lines
2.7 KiB
Rust
use anyhow::Result;
|
|
use bevy_asset::{AssetLoader, LoadContext, LoadedAsset};
|
|
use bevy_ecs::prelude::{FromWorld, World};
|
|
use bevy_utils::BoxedFuture;
|
|
use thiserror::Error;
|
|
|
|
use crate::{
|
|
renderer::RenderDevice,
|
|
texture::{Image, ImageType, TextureError},
|
|
};
|
|
|
|
use super::CompressedImageFormats;
|
|
|
|
/// Loader for images that can be read by the `image` crate.
|
|
#[derive(Clone)]
|
|
pub struct ImageTextureLoader {
|
|
supported_compressed_formats: CompressedImageFormats,
|
|
}
|
|
|
|
const FILE_EXTENSIONS: &[&str] = &[
|
|
#[cfg(feature = "basis-universal")]
|
|
"basis",
|
|
#[cfg(feature = "bmp")]
|
|
"bmp",
|
|
#[cfg(feature = "png")]
|
|
"png",
|
|
#[cfg(feature = "dds")]
|
|
"dds",
|
|
#[cfg(feature = "tga")]
|
|
"tga",
|
|
#[cfg(feature = "jpeg")]
|
|
"jpg",
|
|
#[cfg(feature = "jpeg")]
|
|
"jpeg",
|
|
#[cfg(feature = "ktx2")]
|
|
"ktx2",
|
|
#[cfg(feature = "webp")]
|
|
"webp",
|
|
#[cfg(feature = "pnm")]
|
|
"pam",
|
|
#[cfg(feature = "pnm")]
|
|
"pbm",
|
|
#[cfg(feature = "pnm")]
|
|
"pgm",
|
|
#[cfg(feature = "pnm")]
|
|
"ppm",
|
|
];
|
|
|
|
impl AssetLoader for ImageTextureLoader {
|
|
fn load<'a>(
|
|
&'a self,
|
|
bytes: &'a [u8],
|
|
load_context: &'a mut LoadContext,
|
|
) -> BoxedFuture<'a, Result<()>> {
|
|
Box::pin(async move {
|
|
// use the file extension for the image type
|
|
let ext = load_context.path().extension().unwrap().to_str().unwrap();
|
|
|
|
let dyn_img = Image::from_buffer(
|
|
bytes,
|
|
ImageType::Extension(ext),
|
|
self.supported_compressed_formats,
|
|
true,
|
|
)
|
|
.map_err(|err| FileTextureError {
|
|
error: err,
|
|
path: format!("{}", load_context.path().display()),
|
|
})?;
|
|
|
|
load_context.set_default_asset(LoadedAsset::new(dyn_img));
|
|
Ok(())
|
|
})
|
|
}
|
|
|
|
fn extensions(&self) -> &[&str] {
|
|
FILE_EXTENSIONS
|
|
}
|
|
}
|
|
|
|
impl FromWorld for ImageTextureLoader {
|
|
fn from_world(world: &mut World) -> Self {
|
|
let supported_compressed_formats = match world.get_resource::<RenderDevice>() {
|
|
Some(render_device) => CompressedImageFormats::from_features(render_device.features()),
|
|
|
|
None => CompressedImageFormats::NONE,
|
|
};
|
|
Self {
|
|
supported_compressed_formats,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// An error that occurs when loading a texture from a file.
|
|
#[derive(Error, Debug)]
|
|
pub struct FileTextureError {
|
|
error: TextureError,
|
|
path: String,
|
|
}
|
|
impl std::fmt::Display for FileTextureError {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
|
|
write!(
|
|
f,
|
|
"Error reading image file {}: {}, this is an error in `bevy_render`.",
|
|
self.path, self.error
|
|
)
|
|
}
|
|
}
|