diff options
author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-13 15:40:01 +0100 |
---|---|---|
committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-13 15:40:01 +0100 |
commit | 7ec392eda3345606f0de75a432954b221cee82ce (patch) | |
tree | 48689f986a3c4042ec6b7704dad053f25ef898bf /src/crepe/facade/SoundContext.h | |
parent | 202725f481e64c4d95e370102ab93d4f8cf4af93 (diff) |
add doxygen + check const correctness
Diffstat (limited to 'src/crepe/facade/SoundContext.h')
-rw-r--r-- | src/crepe/facade/SoundContext.h | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/crepe/facade/SoundContext.h b/src/crepe/facade/SoundContext.h index d3123d2..d703c16 100644 --- a/src/crepe/facade/SoundContext.h +++ b/src/crepe/facade/SoundContext.h @@ -6,19 +6,24 @@ namespace crepe { +/** + * \brief Sound engine facade + * + * This class is a wrapper around a \c SoLoud::Soloud instance, which provides + * the methods for playing \c Sound instances. It is part of the sound facade. + */ class SoundContext { private: + // singleton SoundContext(); virtual ~SoundContext(); - - // singleton - static SoundContext & get_instance(); SoundContext(const SoundContext &) = delete; SoundContext(SoundContext &&) = delete; SoundContext & operator=(const SoundContext &) = delete; SoundContext & operator=(SoundContext &&) = delete; private: + static SoundContext & get_instance(); SoLoud::Soloud engine; friend class Sound; }; |