Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AssetMetaMode #10623

Merged
merged 3 commits into from
Nov 27, 2023
Merged

AssetMetaMode #10623

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
321ed77
AssetMetaMode
cart Nov 18, 2023
d58e1fc
AssetMetaMode -> MetaCheck
cart Nov 22, 2023
da83226
Make non-breaking
cart Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions crates/bevy_asset/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ use bevy_ecs::{
};
use bevy_log::error;
use bevy_reflect::{FromReflect, GetTypeRegistration, Reflect, TypePath};
use bevy_utils::HashSet;
use std::{any::TypeId, sync::Arc};

/// Provides "asset" loading and processing functionality. An [`Asset`] is a "runtime value" that is loaded from an [`AssetSource`],
Expand All @@ -75,6 +76,8 @@ pub struct AssetPlugin {
pub watch_for_changes_override: Option<bool>,
/// The [`AssetMode`] to use for this server.
pub mode: AssetMode,
/// How meta files should be accessed. This will be ignored for processed assets, as this mode require meta files.
pub meta_mode: AssetMetaMode,
cart marked this conversation as resolved.
Show resolved Hide resolved
}

#[derive(Debug)]
Expand All @@ -101,13 +104,26 @@ pub enum AssetMode {
Processed,
}

/// Configures how asset meta will be used.
#[derive(Debug, Default, Clone)]
pub enum AssetMetaMode {
/// Always assume assets have meta files.
#[default]
Always,
cart marked this conversation as resolved.
Show resolved Hide resolved
/// Only look up meta files for the provided paths. The default meta will be used for any paths not contained in this set.
Paths(HashSet<AssetPath<'static>>),
/// Never assume assets have meta files. If meta files exist, they will be ignored and the default meta will be used.
Never,
}

impl Default for AssetPlugin {
fn default() -> Self {
Self {
mode: AssetMode::Unprocessed,
file_path: Self::DEFAULT_UNPROCESSED_FILE_PATH.to_string(),
processed_file_path: Self::DEFAULT_PROCESSED_FILE_PATH.to_string(),
watch_for_changes_override: None,
meta_mode: Default::default(),
}
}
}
Expand Down Expand Up @@ -146,6 +162,7 @@ impl Plugin for AssetPlugin {
app.insert_resource(AssetServer::new(
sources,
AssetServerMode::Unprocessed,
self.meta_mode.clone(),
watch,
));
}
Expand All @@ -161,6 +178,7 @@ impl Plugin for AssetPlugin {
sources,
processor.server().data.loaders.clone(),
AssetServerMode::Processed,
AssetMetaMode::Always,
watch,
))
.insert_resource(processor)
Expand All @@ -173,6 +191,7 @@ impl Plugin for AssetPlugin {
app.insert_resource(AssetServer::new(
sources,
AssetServerMode::Processed,
AssetMetaMode::Always,
watch,
));
}
Expand Down
9 changes: 7 additions & 2 deletions crates/bevy_asset/src/processor/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use crate::{
get_asset_hash, get_full_asset_hash, AssetAction, AssetActionMinimal, AssetHash, AssetMeta,
AssetMetaDyn, AssetMetaMinimal, ProcessedInfo, ProcessedInfoMinimal,
},
AssetLoadError, AssetPath, AssetServer, AssetServerMode, DeserializeMetaError,
AssetLoadError, AssetMetaMode, AssetPath, AssetServer, AssetServerMode, DeserializeMetaError,
MissingAssetLoaderForExtensionError,
};
use bevy_ecs::prelude::*;
Expand Down Expand Up @@ -72,7 +72,12 @@ impl AssetProcessor {
// The asset processor uses its own asset server with its own id space
let mut sources = source.build_sources(false, false);
sources.gate_on_processor(data.clone());
let server = AssetServer::new(sources, AssetServerMode::Processed, false);
let server = AssetServer::new(
sources,
AssetServerMode::Processed,
AssetMetaMode::Always,
false,
);
Self { server, data }
}

Expand Down
103 changes: 65 additions & 38 deletions crates/bevy_asset/src/server/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use crate::{
MetaTransform, Settings,
},
path::AssetPath,
Asset, AssetEvent, AssetHandleProvider, AssetId, Assets, DeserializeMetaError,
Asset, AssetEvent, AssetHandleProvider, AssetId, AssetMetaMode, Assets, DeserializeMetaError,
ErasedLoadedAsset, Handle, LoadedUntypedAsset, UntypedAssetId, UntypedHandle,
};
use bevy_ecs::prelude::*;
Expand Down Expand Up @@ -54,6 +54,7 @@ pub(crate) struct AssetServerData {
asset_event_receiver: Receiver<InternalAssetEvent>,
sources: AssetSources,
mode: AssetServerMode,
meta_mode: AssetMetaMode,
}

/// The "asset mode" the server is currently in.
Expand All @@ -68,14 +69,26 @@ pub enum AssetServerMode {
impl AssetServer {
/// Create a new instance of [`AssetServer`]. If `watch_for_changes` is true, the [`AssetReader`] storage will watch for changes to
/// asset sources and hot-reload them.
pub fn new(sources: AssetSources, mode: AssetServerMode, watching_for_changes: bool) -> Self {
Self::new_with_loaders(sources, Default::default(), mode, watching_for_changes)
pub fn new(
sources: AssetSources,
mode: AssetServerMode,
meta_mode: AssetMetaMode,
watching_for_changes: bool,
) -> Self {
Self::new_with_loaders(
sources,
Default::default(),
mode,
meta_mode,
watching_for_changes,
)
}

pub(crate) fn new_with_loaders(
sources: AssetSources,
loaders: Arc<RwLock<AssetLoaders>>,
mode: AssetServerMode,
meta_mode: AssetMetaMode,
watching_for_changes: bool,
) -> Self {
let (asset_event_sender, asset_event_receiver) = crossbeam_channel::unbounded();
Expand All @@ -85,6 +98,7 @@ impl AssetServer {
data: Arc::new(AssetServerData {
sources,
mode,
meta_mode,
asset_event_sender,
asset_event_receiver,
loaders,
Expand Down Expand Up @@ -811,44 +825,57 @@ impl AssetServer {
AssetServerMode::Processed { .. } => source.processed_reader()?,
};
let reader = asset_reader.read(asset_path.path()).await?;
match asset_reader.read_meta_bytes(asset_path.path()).await {
Ok(meta_bytes) => {
// TODO: this isn't fully minimal yet. we only need the loader
let minimal: AssetMetaMinimal = ron::de::from_bytes(&meta_bytes).map_err(|e| {
AssetLoadError::DeserializeMeta {
path: asset_path.clone_owned(),
error: Box::new(DeserializeMetaError::DeserializeMinimal(e)),
}
})?;
let loader_name = match minimal.asset {
AssetActionMinimal::Load { loader } => loader,
AssetActionMinimal::Process { .. } => {
return Err(AssetLoadError::CannotLoadProcessedAsset {
path: asset_path.clone_owned(),
})
}
AssetActionMinimal::Ignore => {
return Err(AssetLoadError::CannotLoadIgnoredAsset {
let read_meta = match &self.data.meta_mode {
AssetMetaMode::Always => true,
AssetMetaMode::Paths(paths) => paths.contains(asset_path),
cart marked this conversation as resolved.
Show resolved Hide resolved
AssetMetaMode::Never => false,
};

if read_meta {
match asset_reader.read_meta_bytes(asset_path.path()).await {
Ok(meta_bytes) => {
// TODO: this isn't fully minimal yet. we only need the loader
let minimal: AssetMetaMinimal =
ron::de::from_bytes(&meta_bytes).map_err(|e| {
AssetLoadError::DeserializeMeta {
path: asset_path.clone_owned(),
error: Box::new(DeserializeMetaError::DeserializeMinimal(e)),
}
})?;
let loader_name = match minimal.asset {
AssetActionMinimal::Load { loader } => loader,
AssetActionMinimal::Process { .. } => {
return Err(AssetLoadError::CannotLoadProcessedAsset {
path: asset_path.clone_owned(),
})
}
AssetActionMinimal::Ignore => {
return Err(AssetLoadError::CannotLoadIgnoredAsset {
path: asset_path.clone_owned(),
})
}
};
let loader = self.get_asset_loader_with_type_name(&loader_name).await?;
let meta = loader.deserialize_meta(&meta_bytes).map_err(|e| {
AssetLoadError::DeserializeMeta {
path: asset_path.clone_owned(),
})
}
};
let loader = self.get_asset_loader_with_type_name(&loader_name).await?;
let meta = loader.deserialize_meta(&meta_bytes).map_err(|e| {
AssetLoadError::DeserializeMeta {
path: asset_path.clone_owned(),
error: Box::new(e),
}
})?;
error: Box::new(e),
}
})?;

Ok((meta, loader, reader))
}
Err(AssetReaderError::NotFound(_)) => {
let loader = self.get_path_asset_loader(asset_path).await?;
let meta = loader.default_meta();
Ok((meta, loader, reader))
Ok((meta, loader, reader))
}
Err(AssetReaderError::NotFound(_)) => {
let loader = self.get_path_asset_loader(asset_path).await?;
let meta = loader.default_meta();
Ok((meta, loader, reader))
}
Err(err) => Err(err.into()),
}
Err(err) => Err(err.into()),
} else {
let loader = self.get_path_asset_loader(asset_path).await?;
let meta = loader.default_meta();
Ok((meta, loader, reader))
}
}

Expand Down