IMAGE: Clarify difference between ImageDecoder and Codec a bit

This commit is contained in:
Matthew Hoops 2014-02-27 21:27:24 -05:00
parent c432b96cf6
commit e6717aaf43
2 changed files with 12 additions and 2 deletions

View File

@ -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

View File

@ -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: