hrev54409 adds 1 changeset to branch 'master'
old head: e6c710f4bb482ddc5f19546ec501ed3af1bdd2f4
new head: e4734ba71050957903efb57d574839307425a189
overview:
https://git.haiku-os.org/haiku/log/?qt=range&q=e4734ba71050+%5Ee6c710f4bb48
----------------------------------------------------------------------------
e4734ba71050: BFileGameSound: add documentation for BDataIO based constructor.
[ Adrien Destugues <pulkomandy@xxxxxxxxxxxxx> ]
----------------------------------------------------------------------------
Revision: hrev54409
Commit: e4734ba71050957903efb57d574839307425a189
URL: https://git.haiku-os.org/haiku/commit/?id=e4734ba71050
Author: Adrien Destugues <pulkomandy@xxxxxxxxxxxxx>
Date: Tue Jul 7 16:10:34 2020 UTC
----------------------------------------------------------------------------
1 file changed, 25 insertions(+)
docs/user/game/FileGameSound.dox | 25 +++++++++++++++++++++++++
----------------------------------------------------------------------------
diff --git a/docs/user/game/FileGameSound.dox b/docs/user/game/FileGameSound.dox
index 8daf2f1306..7374231fd4 100644
--- a/docs/user/game/FileGameSound.dox
+++ b/docs/user/game/FileGameSound.dox
@@ -73,6 +73,31 @@
*/
+/*!
+ \fn BFileGameSound::BFileGameSound(BDataIO* source, bool looping,
+ BGameSoundDevice* device)
+ \brief Creates and initializes a BFileGameSound object from a BDataIO
+ allowing you to play the specified sound data.
+
+ This allows using BFileGameSound with BFile as well as non-file based
+ storage (BMemoryIO, etc).
+
+ If \a looping is \c true, the sound automatically replays from the
+ beginning once the end is reached. This is useful for playing
+ background music in a loop.
+
+ You can specify the sound devise to use by setting the \a device
+ parameter. Setting \a device to \c NULL uses the default sound device.
+
+ \param source The place to get the data from.
+ \param looping Whether or not to repeat the sound in a loop.
+ \param device The sound device to use to play the sound, use \c NULL for
+ default.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn BFileGameSound::~BFileGameSound()
\brief Destroys the BFileGameSound object.
