aboutsummaryrefslogtreecommitdiff
path: root/graphics/iff.h
diff options
context:
space:
mode:
authorMax Horn2009-11-24 22:08:34 +0000
committerMax Horn2009-11-24 22:08:34 +0000
commit0d9609f7f9515a46a0c2c2dbe446b5c5d63cda75 (patch)
treecb2809331c69de6b6d45dffa41dadc76f067ea02 /graphics/iff.h
parentbfc553081c5523ccc5ca0c30178decb374c26fbc (diff)
downloadscummvm-rg350-0d9609f7f9515a46a0c2c2dbe446b5c5d63cda75.tar.gz
scummvm-rg350-0d9609f7f9515a46a0c2c2dbe446b5c5d63cda75.tar.bz2
scummvm-rg350-0d9609f7f9515a46a0c2c2dbe446b5c5d63cda75.zip
Fix incorrectly placed doxygen comments; replace Common::ID2string by Common::tag2string
svn-id: r46127
Diffstat (limited to 'graphics/iff.h')
-rw-r--r--graphics/iff.h49
1 files changed, 16 insertions, 33 deletions
diff --git a/graphics/iff.h b/graphics/iff.h
index 115066cbf5..0aab0e09cb 100644
--- a/graphics/iff.h
+++ b/graphics/iff.h
@@ -22,7 +22,7 @@
* $Id$
*/
-/**
+/*
* Bitmap decoder used in engines:
* - parallaction
* - saga
@@ -104,40 +104,23 @@ struct ILBMDecoder {
-
-// handles PBM subtype of IFF FORM files
-//
-struct PBMDecoder {
- /**
- * PBM header data, necessary for loadBitmap()
- */
- Graphics::BMHD _header;
-
- /**
- * Fills the _header member from the given stream.
- */
- void loadHeader(Common::ReadStream *stream);
-
- /**
- * Loads and unpacks the PBM bitmap data from the stream into the buffer.
- * The functions assumes the buffer is large enough to contain all data.
- */
- void loadBitmap(byte *buffer, Common::ReadStream *stream);
-};
-
+/**
+ * Handles PBM subtype of IFF FORM files
+ */
void decodePBM(Common::ReadStream &input, Surface &surface, byte *colors);
-/*
- PackBits is a RLE compression algorithm introduced
- by Apple. It is also used to encode ILBM and PBM
- subtypes of IFF files, and some flavours of TIFF.
-
- As there is no compression across row boundaries
- in the above formats, read() will extract a *new*
- line on each call, discarding any alignment or
- padding.
-*/
+/**
+ * Decode a given PackBits encoded stream.
+ *
+ * PackBits is an RLE compression algorithm introduced by Apple. It is also
+ * used to encode ILBM and PBM subtypes of IFF files, and some flavours of
+ * TIFF.
+ *
+ * As there is no compression across row boundaries in the above formats,
+ * read() will extract a *new* line on each call, discarding any alignment
+ * or padding.
+ */
class PackBitsReadStream : public Common::ReadStream {
protected:
@@ -152,6 +135,6 @@ public:
uint32 read(void *dataPtr, uint32 dataSize);
};
-}
+} // End of namespace Graphics
#endif