diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-15 20:39:07 +0100 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-15 20:39:07 +0100 |
| commit | e8cd950b8ebd152d76d588d4fedc7f4c239b0835 (patch) | |
| tree | 7919d13a79d52f1365bc19bf1b435a6264ee5512 /src/crepe/facade/Sound.h | |
| parent | 5bee4515c1089ce3499bc3b74780db94f0c02306 (diff) | |
| parent | 9f6475e7b0698c414138e2a8140b47f01ce9c5d1 (diff) | |
merge `master` into `loek/cleanup`
Diffstat (limited to 'src/crepe/facade/Sound.h')
| -rw-r--r-- | src/crepe/facade/Sound.h | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/src/crepe/facade/Sound.h b/src/crepe/facade/Sound.h index 402482f..32b6478 100644 --- a/src/crepe/facade/Sound.h +++ b/src/crepe/facade/Sound.h @@ -19,29 +19,26 @@ public: /** * \brief Pause this sample * - * Pauses this sound if it is playing, or does nothing if it is already - * paused. The playhead position is saved, such that calling \c play() after - * this function makes the sound resume. + * Pauses this sound if it is playing, or does nothing if it is already paused. The playhead + * position is saved, such that calling \c play() after this function makes the sound resume. */ void pause(); /** * \brief Play this sample * - * Resume playback if this sound is paused, or start from the beginning of - * the sample. + * Resume playback if this sound is paused, or start from the beginning of the sample. * - * \note This class only saves a reference to the most recent 'voice' of this - * sound. Calling \c play() while the sound is already playing causes - * multiple instances of the sample to play simultaniously. The sample - * started last is the one that is controlled afterwards. + * \note This class only saves a reference to the most recent 'voice' of this sound. Calling + * \c play() while the sound is already playing causes multiple instances of the sample to + * play simultaniously. The sample started last is the one that is controlled afterwards. */ void play(); /** * \brief Reset playhead position * - * Resets the playhead position so that calling \c play() after this function - * makes it play from the start of the sample. If the sound is not paused - * before calling this function, this function will stop playback. + * Resets the playhead position so that calling \c play() after this function makes it play + * from the start of the sample. If the sound is not paused before calling this function, + * this function will stop playback. */ void rewind(); /** |