aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/facade/Sound.h
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-30 17:27:16 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-30 17:27:16 +0100
commitb8194e02679dc88f5c0a240da83a4700ec5200cf (patch)
tree216e2e28793fce2d468b23fa9b5d2a17db32012b /src/crepe/facade/Sound.h
parent9eff2e24fa4cf0ffad2b47cc922a6558bc1a9fa1 (diff)
add doxygen comments + clean up
Diffstat (limited to 'src/crepe/facade/Sound.h')
-rw-r--r--src/crepe/facade/Sound.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/crepe/facade/Sound.h b/src/crepe/facade/Sound.h
index 35bccdb..a78a2a7 100644
--- a/src/crepe/facade/Sound.h
+++ b/src/crepe/facade/Sound.h
@@ -12,21 +12,24 @@ class SoundContext;
/**
* \brief Sound resource facade
*
- * This class is a wrapper around a \c SoLoud::Wav instance, which holds a
- * single sample. It is part of the sound facade.
+ * This class is a wrapper around a \c SoLoud::Wav instance, which holds a single sample. It is
+ * part of the sound facade.
*/
class Sound : public Resource {
public:
Sound(const Asset & src);
~Sound(); // dbg_trace
+ //! Voice handle wrapper
struct Handle {
+ //! Voice handle (soloud), used by SoundContext
SoLoud::handle handle;
};
private:
+ //! Deserialized resource (soloud)
SoLoud::Wav sample;
-
+ //! SoundContext uses \c sample
friend class SoundContext;
};