lenn/LearnOpenGL
1
0
Fork 0
mirror of https://github.com/JoeyDeVries/LearnOpenGL.git synced 2026-01-02 04:37:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

spelling: successful

Browse Source 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
This commit is contained in:
Josh Soref
2023-01-18 08:35:03 -05:00
parent 28f01479fe
commit cac2036083
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
includes/irrKlang/ik_IAudioStream.h
View File

@@ -26,7 +26,7 @@ public:
//! sets the position of the audio stream. //! sets the position of the audio stream.
/** For example to let the stream be read from the beginning of the file again, /** For example to let the stream be read from the beginning of the file again,
setPosition(0) would be called. This is usually done be the sound engine to setPosition(0) would be called. This is usually done be the sound engine to
loop a stream after if has reached the end. Return true if sucessful and 0 if not. loop a stream after if has reached the end. Return true if successful and 0 if not.
\param pos: Position in frames.*/ \param pos: Position in frames.*/
virtual bool setPosition(ik_s32 pos) = 0; virtual bool setPosition(ik_s32 pos) = 0;

2
includes/irrKlang/ik_ISound.h
View File

@@ -149,7 +149,7 @@ namespace irrklang
using DirectSound. using DirectSound.
\param speed Factor of the speed increase or decrease. 2 is twice as fast, \param speed Factor of the speed increase or decrease. 2 is twice as fast,
0.5 is only half as fast. The default is 1.0. 0.5 is only half as fast. The default is 1.0.
\return Returns true if sucessful, false if not. The current sound driver might not \return Returns true if successful, false if not. The current sound driver might not
support changing the playBack speed, or the sound was started with the support changing the playBack speed, or the sound was started with the
'enableSoundEffects' parameter. */ 'enableSoundEffects' parameter. */
virtual bool setPlaybackSpeed(ik_f32 speed = 1.0f) = 0; virtual bool setPlaybackSpeed(ik_f32 speed = 1.0f) = 0;

12
includes/irrKlang/ik_ISoundEngine.h
View File

@@ -182,7 +182,7 @@ namespace irrklang
\param preload If this flag is set to false (which is default) the sound engine will \param preload If this flag is set to false (which is default) the sound engine will
not try to load the sound file when calling this method, but only when play() is called not try to load the sound file when calling this method, but only when play() is called
with this sound source as parameter. Otherwise the sound will be preloaded. with this sound source as parameter. Otherwise the sound will be preloaded.
\return Returns the pointer to the added sound source or 0 if not sucessful because for \return Returns the pointer to the added sound source or 0 if not successful because for
example a sound already existed with that name. If not successful, the reason will be printed example a sound already existed with that name. If not successful, the reason will be printed
into the log. Note: Don't call drop() to this pointer, it will be managed by irrKlang and into the log. Note: Don't call drop() to this pointer, it will be managed by irrKlang and
exist as long as you don't delete irrKlang or call removeSoundSource(). However, exist as long as you don't delete irrKlang or call removeSoundSource(). However,
@@ -204,7 +204,7 @@ namespace irrklang
savely. If set to false, the memory is not copied and the user takes the responsibility that savely. If set to false, the memory is not copied and the user takes the responsibility that
the memory block pointed to remains there as long as the sound engine or at least this sound the memory block pointed to remains there as long as the sound engine or at least this sound
source exists. source exists.
\return Returns the pointer to the added sound source or 0 if not sucessful because for example a sound already \return Returns the pointer to the added sound source or 0 if not successful because for example a sound already
existed with that name. If not successful, the reason will be printed into the log. existed with that name. If not successful, the reason will be printed into the log.
Note: Don't call drop() to this pointer, it will be managed by irrKlang and exist as long as you don't Note: Don't call drop() to this pointer, it will be managed by irrKlang and exist as long as you don't
delete irrKlang or call removeSoundSource(). However, you are free to call grab() if you delete irrKlang or call removeSoundSource(). However, you are free to call grab() if you
@@ -223,7 +223,7 @@ namespace irrklang
savely. If set to true, the memory is not copied and the user takes the responsibility that savely. If set to true, the memory is not copied and the user takes the responsibility that
the memory block pointed to remains there as long as the sound engine or at least this sound the memory block pointed to remains there as long as the sound engine or at least this sound
source exists. source exists.
\return Returns the pointer to the added sound source or 0 if not sucessful because for \return Returns the pointer to the added sound source or 0 if not successful because for
example a sound already existed with that name. If not successful, the reason will be printed example a sound already existed with that name. If not successful, the reason will be printed
into the log. */ into the log. */
virtual ISoundSource* addSoundSourceFromPCMData(void* memory, ik_s32 sizeInBytes, virtual ISoundSource* addSoundSourceFromPCMData(void* memory, ik_s32 sizeInBytes,
@@ -237,7 +237,7 @@ namespace irrklang
source will use the baseSource as base to access the file and similar, but it will have its source will use the baseSource as base to access the file and similar, but it will have its
own name and its own default settings. own name and its own default settings.
\param soundName Name of the new sound source to be added. \param soundName Name of the new sound source to be added.
\return Returns the pointer to the added sound source or 0 if not sucessful because for \return Returns the pointer to the added sound source or 0 if not successful because for
example a sound already existed with that name. If not successful, the reason will be printed example a sound already existed with that name. If not successful, the reason will be printed
into the log.*/ into the log.*/
virtual ISoundSource* addSoundSourceAlias(ISoundSource* baseSource, const ik_c8* soundName) = 0; virtual ISoundSource* addSoundSourceAlias(ISoundSource* baseSource, const ik_c8* soundName) = 0;
@@ -390,7 +390,7 @@ namespace irrklang
if the parameter ESEO_LOAD_PLUGINS is set (which it is by default), but if the parameter ESEO_LOAD_PLUGINS is set (which it is by default), but
using this method, it is possible to load plugins from a custom path in addition. using this method, it is possible to load plugins from a custom path in addition.
\param path Path to the plugin directory, like "C:\games\somegamegame\irrklangplugins". \param path Path to the plugin directory, like "C:\games\somegamegame\irrklangplugins".
\return returns true if sucessful or false if not, for example because the path could \return returns true if successful or false if not, for example because the path could
not be found. */ not be found. */
virtual bool loadPlugins(const ik_c8* path) = 0; virtual bool loadPlugins(const ik_c8* path) = 0;
@@ -402,7 +402,7 @@ namespace irrklang
//! Sets the OutputMixedDataReceiver, so you can receive the pure mixed output audio data while it is being played. //! Sets the OutputMixedDataReceiver, so you can receive the pure mixed output audio data while it is being played.
/** This can be used to store the sound output as .wav file or for creating a Oscillograph or similar. /** This can be used to store the sound output as .wav file or for creating a Oscillograph or similar.
This works only with software based audio drivers, that is ESOD_WIN_MM, ESOD_ALSA, and ESOD_CORE_AUDIO. This works only with software based audio drivers, that is ESOD_WIN_MM, ESOD_ALSA, and ESOD_CORE_AUDIO.
Returns true if sucessful and false if the current audio driver doesn't support this feature. Set this to null Returns true if successful and false if the current audio driver doesn't support this feature. Set this to null
again once you don't need it anymore. */ again once you don't need it anymore. */
virtual bool setMixedDataOutputReceiver(ISoundMixedOutputReceiver* receiver) = 0; virtual bool setMixedDataOutputReceiver(ISoundMixedOutputReceiver* receiver) = 0;
}; };