summaryrefslogtreecommitdiffstats
path: root/common
diff options
context:
space:
mode:
authorPierre Ossman <ossman@cendio.se>2014-01-20 16:55:19 +0100
committerPierre Ossman <ossman@cendio.se>2014-07-07 13:27:08 +0200
commit823665c23920ef0917b2036079b4be2951445e2c (patch)
treef1460a3d7a79466470db05110539333fe16a1ce6 /common
parent4bca9119848fbafd15dd9dae715ad65162addec5 (diff)
downloadtigervnc-823665c23920ef0917b2036079b4be2951445e2c.tar.gz
tigervnc-823665c23920ef0917b2036079b4be2951445e2c.zip
Document the different pixel representations that we deal with
Diffstat (limited to 'common')
-rw-r--r--common/rfb/PixelFormat.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/common/rfb/PixelFormat.h b/common/rfb/PixelFormat.h
index 10d39026..e05e6f9f 100644
--- a/common/rfb/PixelFormat.h
+++ b/common/rfb/PixelFormat.h
@@ -19,7 +19,16 @@
*/
//
// PixelFormat - structure to represent a pixel format. Also has useful
-// methods for reading & writing to streams, etc.
+// methods for reading & writing to streams, etc. Conversion to and from
+// other formats are also handled by this class. We have three different
+// representations that we refer to:
+//
+// a) Pixels - Unsigned native integers in the format specified by this
+// PixelFormat object.
+// b) Buffer - Same thing as pixels, but in the appropriate byte stream
+// format. This involves endian conversion and padding.
+// c) RGB - A byte stream of 8 bit red, green and blue elements, in that
+// order.
//
#ifndef __RFB_PIXELFORMAT_H__