diff --git a/includes/irrKlang/ik_ISound.h b/includes/irrKlang/ik_ISound.h index 3f267b9..2da8aad 100644 --- a/includes/irrKlang/ik_ISound.h +++ b/includes/irrKlang/ik_ISound.h @@ -166,7 +166,7 @@ namespace irrklang virtual ik_u32 getPlayLength() = 0; //! Returns the sound effect control interface for this sound. - /** Sound effects such as Chorus, Distorsions, Echo, Reverb and similar can + /** Sound effects such as Chorus, Distortions, Echo, Reverb and similar can be controlled using this. The interface pointer is only valid as long as the ISound pointer is valid. If the ISound pointer gets dropped (IVirtualRefCounted::drop()), the ISoundEffects may not be used any more. diff --git a/includes/irrKlang/ik_ISoundEffectControl.h b/includes/irrKlang/ik_ISoundEffectControl.h index ce5c0e2..a38b29e 100644 --- a/includes/irrKlang/ik_ISoundEffectControl.h +++ b/includes/irrKlang/ik_ISoundEffectControl.h @@ -12,7 +12,7 @@ namespace irrklang { //! Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound. - /** Sound effects such as chorus, distorsions, echo, reverb and similar can + /** Sound effects such as chorus, distortions, echo, reverb and similar can be controlled using this. An instance of this interface can be obtained via ISound::getSoundEffectControl(). The sound containing this interface has to be started via ISoundEngine::play2D() or ISoundEngine::play3D() with the flag enableSoundEffects=true, diff --git a/includes/irrKlang/ik_ISoundEngine.h b/includes/irrKlang/ik_ISoundEngine.h index 048f643..f6ccfd5 100644 --- a/includes/irrKlang/ik_ISoundEngine.h +++ b/includes/irrKlang/ik_ISoundEngine.h @@ -45,7 +45,7 @@ namespace irrklang \param streamMode Specifies if the file should be streamed or loaded completely into memory for playing. ESM_AUTO_DETECT sets this to autodetection. Note: if the sound has been loaded or played before into the engine, this parameter has no effect. - \param enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, + \param enableSoundEffects Makes it possible to use sound effects such as chorus, distortions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary. \return Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or @@ -73,7 +73,7 @@ namespace irrklang Note: You need to call ISound::drop() when setting this parameter to true and you don't need the ISound object anymore. See 'return' for details. \param track Makes it possible to track the sound. Causes the method to return an ISound interface. See 'return' for details. - \param enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, + \param enableSoundEffects Makes it possible to use sound effects such as chorus, distortions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary. \return Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or @@ -102,7 +102,7 @@ namespace irrklang \param streamMode Specifies if the file should be streamed or loaded completely into memory for playing. ESM_AUTO_DETECT sets this to autodetection. Note: if the sound has been loaded or played before into the engine, this parameter has no effect. - \param enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, + \param enableSoundEffects Makes it possible to use sound effects such as chorus, distortions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary. \return Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or @@ -131,7 +131,7 @@ namespace irrklang Note: You need to call ISound::drop() when setting this parameter to true and you don't need the ISound object anymore. See 'return' for details. \param track Makes it possible to track the sound. Causes the method to return an ISound interface. See 'return' for details. - \param enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, + \param enableSoundEffects Makes it possible to use sound effects such as chorus, distortions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary. \return Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or