mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-29 06:41:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improved documentation of SoundStream::onGetData (#650)

Browse Source
This commit is contained in:
Laurent Gomila 2014-07-11 17:43:18 +02:00
parent 471873dff9
commit 8db958042e
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/SFML/Audio/SoundStream.hpp
View File

@ -209,6 +209,9 @@ protected :
/// streaming loop, in a separate thread. /// streaming loop, in a separate thread.
/// The source can choose to stop the streaming loop at any time, by /// The source can choose to stop the streaming loop at any time, by
/// returning false to the caller. /// returning false to the caller.
/// If you return true (i.e. continue streaming) it is important that
/// the returned array of samples is not empty; this would stop the stream
/// due to an internal limitation.
/// ///
/// \param data Chunk of data to fill /// \param data Chunk of data to fill
/// ///
@ -352,6 +355,7 @@ private :
/// virtual bool onGetData(Chunk& data) /// virtual bool onGetData(Chunk& data)
/// { /// {
/// // Fill the chunk with audio data from the stream source /// // Fill the chunk with audio data from the stream source
/// // (note: must not be empty if you want to continue playing)
/// data.samples = ...; /// data.samples = ...;
/// data.sampleCount = ...; /// data.sampleCount = ...;
/// ///