aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Hoops2013-10-26 10:18:48 -0400
committerMatthew Hoops2013-10-26 10:21:03 -0400
commit1b3eee6d78438b14b437fa6036ef6a1cf45af578 (patch)
tree65025c615bddeff8aeb65edb4e6f5cd2670dafab
parent92c1ff31d6d8d78e58caa4d123ceb0fea43a48ed (diff)
downloadscummvm-rg350-1b3eee6d78438b14b437fa6036ef6a1cf45af578.tar.gz
scummvm-rg350-1b3eee6d78438b14b437fa6036ef6a1cf45af578.tar.bz2
scummvm-rg350-1b3eee6d78438b14b437fa6036ef6a1cf45af578.zip
GRAPHICS: Clarify implicit destroy() usage
-rw-r--r--graphics/decoders/image_decoder.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/graphics/decoders/image_decoder.h b/graphics/decoders/image_decoder.h
index 49e31c6e3a..a39a9a1493 100644
--- a/graphics/decoders/image_decoder.h
+++ b/graphics/decoders/image_decoder.h
@@ -44,6 +44,9 @@ public:
/**
* Load an image from the specified stream
+ *
+ * loadStream() should implicitly call destroy() to free the memory
+ * of the last loadStream() call.
*
* @param stream the input stream
* @return whether loading the file succeeded
@@ -54,6 +57,9 @@ public:
/**
* Destroy this decoder's surface and palette
+ *
+ * This should be called by a loadStream() implementation as well
+ * as the destructor.
*/
virtual void destroy() = 0;