Fix inconsistent interpretation of ld() in image handling (STR #3308).

Documentation has been fixed and clarified, and ld() handling is now
consistent in Fl_(RGB_)Image, their subclasses and fl_draw_image()
and similar functions.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@12029 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

1 files changed, 10 insertions, 3 deletions

diff --git a/FL/Fl_Image.H b/FL/Fl_Image.H
index f2e68bc1b..203a91d3b 100644
--- a/FL/Fl_Image.H
+++ b/FL/Fl_Image.H
@@ -3,7 +3,7 @@
 //
 // Image header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2014 by Bill Spitzak and others.
+// Copyright 1998-2016 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
 // the file "COPYING" which should have been included with this file.  If this
@@ -85,6 +85,14 @@ protected:
   void d(int D) {d_ = D;}
   /**
    Sets the current line data size in bytes.
+
+   Color images may contain extra data that is included after every
+   line of color image data and is normally not present.
+
+   If \p LD is zero, then line data size is assumed to be w() * d() bytes.
+
+   If \p LD is non-zero, then it must be positive and larger than w() * d()
+   to account for the extra data per line.
    */
   void ld(int LD) {ld_ = LD;}
   /** 
@@ -114,8 +122,7 @@ public:
   int d() const {return d_;}
   /**
    Returns the current line data size in bytes.
-   Line data is extra data that is included
-   after each line of color image data and is normally not present.
+   \see ld(int)
    */
   int ld() const {return ld_;}
   /**