summaryrefslogtreecommitdiff
path: root/src/SFML/Audio/SoundFileReaderOgg.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/SFML/Audio/SoundFileReaderOgg.hpp')
-rw-r--r--src/SFML/Audio/SoundFileReaderOgg.hpp5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/SFML/Audio/SoundFileReaderOgg.hpp b/src/SFML/Audio/SoundFileReaderOgg.hpp
index 2b9917b..36ac7a6 100644
--- a/src/SFML/Audio/SoundFileReaderOgg.hpp
+++ b/src/SFML/Audio/SoundFileReaderOgg.hpp
@@ -1,7 +1,7 @@
////////////////////////////////////////////////////////////
//
// SFML - Simple and Fast Multimedia Library
-// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
+// Copyright (C) 2007-2016 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.
@@ -82,6 +82,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Change the current read position to the given sample offset
///
+ /// The sample offset takes the channels into account.
+ /// Offsets can be calculated like this:
+ /// `sampleNumber * sampleRate * channelCount`
/// If the given offset exceeds to total number of samples,
/// this function must jump to the end of the file.
///