COMMON: Mention that SafeSeekableSubReadStream is not threading safe.

scummvm · Mar 10, 2012 · d7ba69c · d7ba69c
1 parent 48efab4
commit d7ba69c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/common/substream.h b/common/substream.h
@@ -103,6 +103,9 @@ class SeekableSubReadStreamEndian : public SeekableSubReadStream, public ReadStr
  * at the same time; they won't mess up each other. They will, however,
  * reposition the parent stream, so don't depend on its position to be
  * the same after a read() or seek() on one of its SafeSeekableSubReadStream.
+ *
+ * Note that this stream is *not* threading safe. Calling read from the audio
+ * thread and from the main thread might mess up the data retrieved.
  */
 class SafeSeekableSubReadStream : public SeekableSubReadStream {
 public: