From: Lectem <lectem@gmail.com>
Date: Fri, 9 Oct 2015 23:41:29 +0000 (-0400)
Subject: Document the loop behaviour of csndPlaySound
X-Git-Tag: v1.0.0~74^2
X-Git-Url: https://chaos.moe/g/?a=commitdiff_plain;h=f14d5721ebe9c5f5b5ed85ba88ee40d9bb4d72bb;p=corbenik%2Fctrulib.git

Document the loop behaviour of csndPlaySound
---

diff --git a/libctru/include/3ds/services/csnd.h b/libctru/include/3ds/services/csnd.h
index ea1f519..64a964e 100644
--- a/libctru/include/3ds/services/csnd.h
+++ b/libctru/include/3ds/services/csnd.h
@@ -363,8 +363,10 @@ Result CSND_UpdateInfo(bool waitDone);
  * @param vol The volume, ranges from 0.0 to 1.0 included.
  * @param pan The pan, ranges from -1.0 to 1.0 included.
  * @param data0 First block of sound data.
- * @param data1 Second block of sound data. Used as a loop destination.
+ * @param data1 Second block of sound data. This is the block that will be looped over.
  * @param size Size of the sound data.
+ * 
+ * In this implementation if the loop mode is used, data1 must be in the range [data0 ; data0 + size]. Sound will be played once from data0 to data0 + size and then loop between data1 and data0+size.
  */
 Result csndPlaySound(int chn, u32 flags, u32 sampleRate, float vol, float pan, void* data0, void* data1, u32 size);