aboutsummaryrefslogtreecommitdiff
path: root/image
diff options
context:
space:
mode:
Diffstat (limited to 'image')
-rw-r--r--image/codecs/codec.h12
-rw-r--r--image/image_decoder.h2
2 files changed, 12 insertions, 2 deletions
diff --git a/image/codecs/codec.h b/image/codecs/codec.h
index c84f3e3308..1b7a295e9d 100644
--- a/image/codecs/codec.h
+++ b/image/codecs/codec.h
@@ -33,8 +33,16 @@ class SeekableReadStream;
namespace Image {
/**
- * An abstract representation of a video codec used for decoding
- * video frames.
+ * An abstract representation of a image codec.
+ *
+ * Unlike ImageDecoder, the entire info for a frame may not be present
+ * within the stream. The codec may rely on the supporting container
+ * for parameters and can also rely on a previous (or future) frame.
+ * When decoding, the previous frame may not destroyed and could be
+ * maintained for use in the next one.
+ *
+ * An ImageDecoder can always be a Codec, but a Codec may not necessarily
+ * be able to be an ImageDecoder.
*
* Used in video:
* - AVIDecoder
diff --git a/image/image_decoder.h b/image/image_decoder.h
index 08fa4d82b4..4d3512e0f6 100644
--- a/image/image_decoder.h
+++ b/image/image_decoder.h
@@ -39,6 +39,8 @@ namespace Image {
/**
* A representation of an image decoder that maintains ownership of the surface
* and palette it decodes to.
+ *
+ * This is designed for still frames only.
*/
class ImageDecoder {
public: