Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Corrected/clarified the setLoopPoints() documentation

Browse Source 
The previous documentation talks about 'end points' but the current code does not take end point as an argument and hence does not allow specifying the end point of the loop. (Instead the functions allows specifying the beginning offset and the length of the loop.)
This commit is contained in:
Coder-Rahul-Y 2022-04-28 16:18:08 +05:30 committed by Lukas Dürrenberger
parent b6ca47e128
commit 33cb8f4391
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/SFML/Audio/Music.hpp
View File

@ -189,11 +189,11 @@ public:
TimeSpan getLoopPoints() const; TimeSpan getLoopPoints() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Sets the beginning and end of the sound's looping sequence using sf::Time /// \brief Sets the beginning and duration of the sound's looping sequence using sf::Time
/// ///
/// Loop points allow one to specify a pair of positions such that, when the music /// setLoopPoints() allows for specifying the beginning offset and the duration of the loop such that, when the music
/// is enabled for looping, it will seamlessly seek to the beginning whenever it /// is enabled for looping, it will seamlessly seek to the beginning whenever it
/// encounters the end. Valid ranges for timePoints.offset and timePoints.length are /// encounters the end of the duration. Valid ranges for timePoints.offset and timePoints.length are
/// [0, Dur) and (0, Dur-offset] respectively, where Dur is the value returned by getDuration(). /// [0, Dur) and (0, Dur-offset] respectively, where Dur is the value returned by getDuration().
/// Note that the EOF "loop point" from the end to the beginning of the stream is still honored, /// Note that the EOF "loop point" from the end to the beginning of the stream is still honored,
/// in case the caller seeks to a point after the end of the loop range. This function can be /// in case the caller seeks to a point after the end of the loop range. This function can be