diff options
| author | Max Horn | 2007-04-27 19:50:45 +0000 |
|---|---|---|
| committer | Max Horn | 2007-04-27 19:50:45 +0000 |
| commit | 4958b5862251e7106c9a2d5d8a71f2a737324f03 (patch) | |
| tree | bf2ce3f82bd02ad2a75aafd088801b87887cadca | |
| parent | bfe346afd2e59fa42645e4f4b292a71e1a1704f3 (diff) | |
| download | scummvm-rg350-4958b5862251e7106c9a2d5d8a71f2a737324f03.tar.gz scummvm-rg350-4958b5862251e7106c9a2d5d8a71f2a737324f03.tar.bz2 scummvm-rg350-4958b5862251e7106c9a2d5d8a71f2a737324f03.zip | |
Added a doxygen comment to makeProtrackerStream -- somebody who knows the code behind this please complete/enhance this
svn-id: r26616
| -rw-r--r-- | sound/mods/protracker.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/sound/mods/protracker.h b/sound/mods/protracker.h index 939b336b2f..7fefddd20c 100644 --- a/sound/mods/protracker.h +++ b/sound/mods/protracker.h @@ -31,6 +31,17 @@ namespace Audio { class AudioStream; +/* + * Factory function for ProTracker streams. Reads all data from the + * given ReadStream and creates an AudioStream from this. No reference + * to the 'stream' object is kept, so you can safely delete it after + * invoking this factory. + * + * @param stream the ReadStream from which to read the ProTracker data + * @param rate TODO + * @param stereo TODO + * @return a new AudioStream, or NULL, if an error occured + */ AudioStream *makeProtrackerStream(Common::ReadStream *stream, int rate = 44100, bool stereo = true); } // End of namespace Audio |