mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-28 22:31:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Correct docstring for seek

Browse Source
This commit is contained in:
Sérgio Agostinho 2018-01-25 20:49:43 +00:00 committed by Lukas Dürrenberger
parent 6d122e96e1
commit 6d4e870e32
5 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/SFML/Audio/InputSoundFile.hpp
View File

@ -159,8 +159,9 @@ public:
/// other overload. /// other overload.
/// ///
/// The sample offset takes the channels into account. /// The sample offset takes the channels into account.
/// Offsets can be calculated like this: /// If you have a time offset instead, you can easily find
/// `sampleNumber * sampleRate * channelCount` /// the corresponding sample offset with the following formula:
/// `timeInSeconds * sampleRate * channelCount`
/// If the given offset exceeds to total number of samples, /// If the given offset exceeds to total number of samples,
/// this function jumps to the end of the sound file. /// this function jumps to the end of the sound file.
/// ///

5
include/SFML/Audio/SoundFileReader.hpp
View File

@ -80,8 +80,9 @@ public:
/// \brief Change the current read position to the given sample offset /// \brief Change the current read position to the given sample offset
/// ///
/// The sample offset takes the channels into account. /// The sample offset takes the channels into account.
/// Offsets can be calculated like this: /// If you have a time offset instead, you can easily find
/// `sampleNumber * sampleRate * channelCount` /// the corresponding sample offset with the following formula:
/// `timeInSeconds * sampleRate * channelCount`
/// If the given offset exceeds to total number of samples, /// If the given offset exceeds to total number of samples,
/// this function must jump to the end of the file. /// this function must jump to the end of the file.
/// ///

5
src/SFML/Audio/SoundFileReaderFlac.hpp
View File

@ -83,8 +83,9 @@ public:
/// \brief Change the current read position to the given sample offset /// \brief Change the current read position to the given sample offset
/// ///
/// The sample offset takes the channels into account. /// The sample offset takes the channels into account.
/// Offsets can be calculated like this: /// If you have a time offset instead, you can easily find
/// `sampleNumber * sampleRate * channelCount` /// the corresponding sample offset with the following formula:
/// `timeInSeconds * sampleRate * channelCount`
/// If the given offset exceeds to total number of samples, /// If the given offset exceeds to total number of samples,
/// this function must jump to the end of the file. /// this function must jump to the end of the file.
/// ///

5
src/SFML/Audio/SoundFileReaderOgg.hpp
View File

@ -83,8 +83,9 @@ public:
/// \brief Change the current read position to the given sample offset /// \brief Change the current read position to the given sample offset
/// ///
/// The sample offset takes the channels into account. /// The sample offset takes the channels into account.
/// Offsets can be calculated like this: /// If you have a time offset instead, you can easily find
/// `sampleNumber * sampleRate * channelCount` /// the corresponding sample offset with the following formula:
/// `timeInSeconds * sampleRate * channelCount`
/// If the given offset exceeds to total number of samples, /// If the given offset exceeds to total number of samples,
/// this function must jump to the end of the file. /// this function must jump to the end of the file.
/// ///

5
src/SFML/Audio/SoundFileReaderWav.hpp
View File

@ -75,8 +75,9 @@ public:
/// \brief Change the current read position to the given sample offset /// \brief Change the current read position to the given sample offset
/// ///
/// The sample offset takes the channels into account. /// The sample offset takes the channels into account.
/// Offsets can be calculated like this: /// If you have a time offset instead, you can easily find
/// `sampleNumber * sampleRate * channelCount` /// the corresponding sample offset with the following formula:
/// `timeInSeconds * sampleRate * channelCount`
/// If the given offset exceeds to total number of samples, /// If the given offset exceeds to total number of samples,
/// this function must jump to the end of the file. /// this function must jump to the end of the file.
/// ///