Merge pull request #125 from mgi388/pub-asset-loaders

Make asset loaders public in prelude
NiklasEi · Jun 29, 2024 · dba0bb6 · dba0bb6
2 parents 02dc1f4 + 4c6e017
commit dba0bb6
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -71,6 +71,21 @@ pub mod prelude {
     #[doc(hidden)]
     pub use crate::instance::{AudioCommandError, AudioInstance, AudioInstanceAssetsExt};
     #[doc(hidden)]
+    #[cfg(feature = "flac")]
+    pub use crate::source::flac_loader::*;
+    #[doc(hidden)]
+    #[cfg(feature = "mp3")]
+    pub use crate::source::mp3_loader::*;
+    #[doc(hidden)]
+    #[cfg(feature = "ogg")]
+    pub use crate::source::ogg_loader::*;
+    #[doc(hidden)]
+    #[cfg(feature = "settings_loader")]
+    pub use crate::source::settings_loader::*;
+    #[doc(hidden)]
+    #[cfg(feature = "wav")]
+    pub use crate::source::wav_loader::*;
+    #[doc(hidden)]
     pub use crate::source::AudioSource;
     #[doc(hidden)]
     pub use crate::spatial::{AudioEmitter, AudioReceiver, SpatialAudio};
@@ -80,7 +95,7 @@ pub mod prelude {
         dsp::Frame,
         sound::{
             static_sound::{StaticSoundData, StaticSoundSettings},
-            Sound, SoundData,
+            FromFileError, Sound, SoundData,
         },
         Volume,
     };

diff --git a/src/source/flac_loader.rs b/src/source/flac_loader.rs
@@ -21,6 +21,7 @@ pub enum FlacLoaderError {
     FileError(#[from] FromFileError),
 }
 
+/// Asset loader for FLAC files.
 #[derive(Default)]
 pub struct FlacLoader;
 

diff --git a/src/source/mp3_loader.rs b/src/source/mp3_loader.rs
@@ -9,6 +9,7 @@ use thiserror::Error;
 
 use crate::source::AudioSource;
 
+/// Asset loader for MP3 files.
 #[derive(Default)]
 pub struct Mp3Loader;
 

diff --git a/src/source/ogg_loader.rs b/src/source/ogg_loader.rs
@@ -21,6 +21,7 @@ pub enum OggLoaderError {
     FileError(#[from] FromFileError),
 }
 
+/// Asset loader for OGG files.
 #[derive(Default)]
 pub struct OggLoader;
 

diff --git a/src/source/settings_loader.rs b/src/source/settings_loader.rs
@@ -13,6 +13,7 @@ use thiserror::Error;
 
 use crate::AudioSource;
 
+/// Asset loader for sound settings files.
 #[derive(Default)]
 pub struct SettingsLoader;
 

diff --git a/src/source/wav_loader.rs b/src/source/wav_loader.rs
@@ -9,6 +9,7 @@ use thiserror::Error;
 
 use crate::source::AudioSource;
 
+/// Asset loader for WAV files.
 #[derive(Default)]
 pub struct WavLoader;