Fix mis-alignment of copied AlignedImages; add some asserts; some docs.

[dcpomatic.git] / src / lib / image.h

diff --git a/src/lib/image.h b/src/lib/image.h
index 69f3a883722b3f10a4c8e609ee4bf35834b8a01e..7c118f338c84f0c52998dda9d814871354c90677 100644 (file)
--- a/src/lib/image.h
+++ b/src/lib/image.h
@@ -127,6 +127,9 @@ private:
        int* _stride; ///< array of strides for each line (including any alignment padding bytes)
 };
 
+/** @class AlignedImage
+ *  @brief An image whose pixel data is padded so that rows always start on 32-byte boundaries.
+ */
 class AlignedImage : public SimpleImage
 {
 public:
@@ -134,6 +137,9 @@ public:
        AlignedImage (boost::shared_ptr<Image>);
 };
 
+/** @class CompactImage
+ *  @brief An image whose pixel data is not padded, so rows may start at any pixel alignment.
+ */
 class CompactImage : public SimpleImage
 {
 public: