diff options
author | Chris Xiong <chirs241097@gmail.com> | 2015-12-07 23:49:44 +0800 |
---|---|---|
committer | Chris Xiong <chirs241097@gmail.com> | 2015-12-07 23:49:44 +0800 |
commit | 49e67bc8566e8c5017b931837792a648cb0048c2 (patch) | |
tree | 2096cada4bc57e2f89ea4983aa1b045d6780ea4e /doc | |
parent | e8a4c69dd159cf248c2335775a69a1214f0c9bc7 (diff) | |
download | SMELT-49e67bc8566e8c5017b931837792a648cb0048c2.tar.xz |
Add RIFF wave format support. Update documentation.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/SMELTdoc | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/SMELTdoc b/doc/SMELTdoc index 2f6bdd2..4bbc7a3 100644 --- a/doc/SMELTdoc +++ b/doc/SMELTdoc @@ -158,10 +158,13 @@ float smGetTime() [core/FPS] Gets the time in milliseconds since the call to smInit(). SMSFX smSFXLoad(const char *path) [core/SFX] -Loads a sound file from the given path. Only ogg files are supported. +Loads a sound file from the given path. Only ogg and wav files are supported. +Further more, due to the restrictions of OpenAL, only 8/16bit mono/stereo formats +are supported. SMSFX smSFXLoadFromMemory(const char *ptr,DWORD size) [core/SFX] -Loads a sound file from the given memory block. Only ogg files are supported. +Loads a sound file from the given memory block. Limitations are the same to that +of smSFXLoad. SMCHN smSFXPlay(SMSFX fx,int vol=100,int pan=0,float pitch=1.,bool loop=0) [core/SFX] @@ -170,7 +173,7 @@ A channel is generated and can be used to control the playing of the SFX. The channel is valid until it stops. Volume should be 0~100. Panning should be -100~100. -The values would be clamped to the range given above. +The values will be clamped to the range given above. float smSFXGetLengthf(SMSFX fx) [core/SFX] Gets the sound length in seconds. |