summaryrefslogtreecommitdiff
path: root/include/SFML/Audio/Music.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/SFML/Audio/Music.hpp')
-rw-r--r--include/SFML/Audio/Music.hpp20
1 files changed, 10 insertions, 10 deletions
diff --git a/include/SFML/Audio/Music.hpp b/include/SFML/Audio/Music.hpp
index 5351905..4c4eefb 100644
--- a/include/SFML/Audio/Music.hpp
+++ b/include/SFML/Audio/Music.hpp
@@ -1,7 +1,7 @@
////////////////////////////////////////////////////////////
//
// SFML - Simple and Fast Multimedia Library
-// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
@@ -79,8 +79,8 @@ public:
}
- T offset; ///< The beginning offset of the time range
- T length; ///< The length of the time range
+ T offset; //!< The beginning offset of the time range
+ T length; //!< The length of the time range
};
// Define the relevant Span types
@@ -189,11 +189,11 @@ public:
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
- /// 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().
/// 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
@@ -276,10 +276,10 @@ private:
////////////////////////////////////////////////////////////
// Member data
////////////////////////////////////////////////////////////
- InputSoundFile m_file; ///< The streamed music file
- std::vector<Int16> m_samples; ///< Temporary buffer of samples
- Mutex m_mutex; ///< Mutex protecting the data
- Span<Uint64> m_loopSpan; ///< Loop Range Specifier
+ InputSoundFile m_file; //!< The streamed music file
+ std::vector<Int16> m_samples; //!< Temporary buffer of samples
+ Mutex m_mutex; //!< Mutex protecting the data
+ Span<Uint64> m_loopSpan; //!< Loop Range Specifier
};
} // namespace sf