aboutsummaryrefslogtreecommitdiffstats
path: root/mumd/src/audio/sound_effects.rs
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2021-06-19 16:33:51 +0200
committerGustav Sörnäs <gustav@sornas.net>2021-06-19 16:33:51 +0200
commit402d51d25b8336c85154fa912e7dd1739fdfc55f (patch)
treee4d0162426ba09a17c57720f9483ba956f9bbc99 /mumd/src/audio/sound_effects.rs
parent6b9d837c447c520106b0d888103ad77af93046f4 (diff)
downloadmum-402d51d25b8336c85154fa912e7dd1739fdfc55f.tar.gz
more doc
Diffstat (limited to 'mumd/src/audio/sound_effects.rs')
-rw-r--r--mumd/src/audio/sound_effects.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/mumd/src/audio/sound_effects.rs b/mumd/src/audio/sound_effects.rs
index 49cb009..b6f41f1 100644
--- a/mumd/src/audio/sound_effects.rs
+++ b/mumd/src/audio/sound_effects.rs
@@ -15,6 +15,7 @@ use strum_macros::EnumIter;
use crate::audio::SAMPLE_RATE;
+/// The different kinds of files we can open.
enum AudioFileKind {
Ogg,
Wav,
@@ -32,11 +33,13 @@ impl TryFrom<&str> for AudioFileKind {
}
}
+/// A specification accompanying some audio data.
struct AudioSpec {
channels: u32,
sample_rate: u32,
}
+/// An event where a notification is shown and a sound effect is played.
#[derive(Debug, Eq, PartialEq, Clone, Copy, Hash, EnumIter)]
pub enum NotificationEvents {
ServerConnect,