summaryrefslogtreecommitdiffstats
path: root/src/pngenc.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/pngenc.h')
-rw-r--r--src/pngenc.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/pngenc.h b/src/pngenc.h
index c86cbce..66379cb 100644
--- a/src/pngenc.h
+++ b/src/pngenc.h
@@ -22,6 +22,7 @@
typedef unsigned char Byte;
+/*! \brief Entry in the color palette of a PNG image */
struct Color
{
Byte red;
@@ -29,6 +30,11 @@ struct Color
Byte blue;
};
+/*! \brief PNG image encoder
+ *
+ * This class allows to encode a raw image to a compressed PNG.
+ * Use write() to save the result to disk.
+ */
class PngEncoder
{
public:
@@ -36,8 +42,6 @@ class PngEncoder
~PngEncoder();
void write(const char *fileName);
- protected:
-
private:
// image variables
Byte *data; // pointer to the image data (one byte per pixel)