From ac4efb54f3f0cd649c9797d38504b0330d5baf1e Mon Sep 17 00:00:00 2001 From: Laurent Gomila Date: Wed, 14 Mar 2012 19:05:51 +0100 Subject: [PATCH] Improved the documentation of Music::openFromXxx functions --- include/SFML/Audio/Music.hpp | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/SFML/Audio/Music.hpp b/include/SFML/Audio/Music.hpp index e36c5e1d..784addd3 100644 --- a/include/SFML/Audio/Music.hpp +++ b/include/SFML/Audio/Music.hpp @@ -91,6 +91,10 @@ public : /// Here is a complete list of all the supported audio formats: /// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. + /// Since the music is not loaded completely but rather streamed + /// continuously, the \a data must remain available as long as the + /// music is playing (ie. you can't deallocate it right after calling + /// this function). /// /// \param data Pointer to the file data in memory /// \param sizeInBytes Size of the data to load, in bytes @@ -110,6 +114,10 @@ public : /// Here is a complete list of all the supported audio formats: /// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. + /// Since the music is not loaded completely but rather streamed + /// continuously, the \a stream must remain alive as long as the + /// music is playing (ie. you can't destroy it right after calling + /// this function). /// /// \param stream Source stream to read from ///