GraphicsMagick: Magick++: Update getIndexes() and getConstIndexe...

changeset f888dee94268 in /hg/GraphicsMagick
details: http://hg.GraphicsMagick.org/hg/GraphicsMagick?cmd=changeset;node=f888dee94268
summary: Magick++: Update getIndexes() and getConstIndexes() documention to mention that the selected region is defined by a prior getPixels(), getConstPixels(), or setPixels() call.

diffstat:

 ChangeLog                     |   6 ++++++
 Magick++/lib/Magick++/Image.h |  13 ++++++++-----
 www/Changelog.html            |   5 +++++
 www/Magick++/Image.html       |  19 ++++++++++++-------
 www/Magick++/Image.rst        |  19 ++++++++++++-------
 5 files changed, 43 insertions(+), 19 deletions(-)

diffs (159 lines):

diff -r eaa9f32ff59d -r f888dee94268 ChangeLog
--- a/ChangeLog	Sun May 08 11:09:42 2022 -0500
+++ b/ChangeLog	Sun May 08 18:40:47 2022 -0500
@@ -1,5 +1,11 @@
 2022-05-08  Bob Friesenhahn  <[email protected]>
 
+        * www/Magick++/Image.rst: Update getIndexes() and
+        getConstIndexes() documention to mention that the selected region
+        is defined by a prior getPixels(), getConstPixels(), or
+        setPixels() call.  This is inspired by private email from Miro
+        Kropáček on May 8, 2022.
+
         * coders/jpeg.c (WriteJPEGImage): Change "arithmetic" to
         "arithmetic-coding" in order to match ImageMagick's previously
         existing syntax.
diff -r eaa9f32ff59d -r f888dee94268 Magick++/lib/Magick++/Image.h
--- a/Magick++/lib/Magick++/Image.h	Sun May 08 11:09:42 2022 -0500
+++ b/Magick++/lib/Magick++/Image.h	Sun May 08 18:40:47 2022 -0500
@@ -1305,21 +1305,24 @@
 
 
     // Transfers read-only pixels from the image to the pixel cache as
-    // defined by the specified region
+    // defined by the specified region.
     const PixelPacket* getConstPixels ( const int x_, const int y_,
                                         const unsigned int columns_,
                                         const unsigned int rows_ ) const;
 
-    // Obtain mutable image pixel indexes (valid for PseudoClass images)
+    // Obtain mutable image pixel indexes (valid for PseudoClass
+    // images).  The selected region is defined by the prior
+    // getPixels(), getConstPixels(), or setPixels() call.
     IndexPacket* getIndexes ( void );
 
-    // Obtain immutable image pixel indexes (valid for PseudoClass images)
+    // Obtain immutable image pixel indexes (valid for PseudoClass
+    // images). The selected region is defined by a prior getPixels(),
+    // getConstPixels(), or setPixels() call.
     const IndexPacket* getConstIndexes ( void ) const;
 
     // Transfers pixels from the image to the pixel cache as defined
     // by the specified region. Modified pixels may be subsequently
-    // transferred back to the image via syncPixels.  This method is
-    // valid for DirectClass images.
+    // transferred back to the image via syncPixels.
     PixelPacket* getPixels ( const int x_, const int y_,
                              const unsigned int columns_,
                              const unsigned int rows_ );
diff -r eaa9f32ff59d -r f888dee94268 www/Changelog.html
--- a/www/Changelog.html	Sun May 08 11:09:42 2022 -0500
+++ b/www/Changelog.html	Sun May 08 18:40:47 2022 -0500
@@ -37,6 +37,11 @@
 
 <p>2022-05-08  Bob Friesenhahn  &lt;<a class="reference external" href="mailto:bfriesen&#37;&#52;&#48;simple&#46;dallas&#46;tx&#46;us">bfriesen<span>&#64;</span>simple<span>&#46;</span>dallas<span>&#46;</span>tx<span>&#46;</span>us</a>&gt;</p>
 <blockquote>
+<p>* www/Magick++/Image.rst: Update getIndexes() and
+getConstIndexes() documention to mention that the selected region
+is defined by a prior getPixels(), getConstPixels(), or
+setPixels() call.  This is inspired by private email from Miro
+Kropáček on May 8, 2022.</p>
 <p>* coders/jpeg.c (WriteJPEGImage): Change &quot;arithmetic&quot; to
 &quot;arithmetic-coding&quot; in order to match ImageMagick's previously
 existing syntax.</p>
diff -r eaa9f32ff59d -r f888dee94268 www/Magick++/Image.html
--- a/www/Magick++/Image.html	Sun May 08 11:09:42 2022 -0500
+++ b/www/Magick++/Image.html	Sun May 08 18:40:47 2022 -0500
@@ -2939,7 +2939,8 @@
 </div>
 <div class="section" id="getconstpixels">
 <h2><a class="toc-backref" href="#id221">getConstPixels</a></h2>
-<p>Transfers read-only pixels from the image to the pixel cache as
+<p>Transfers read-only pixels (DirectClass PixelPackets, and IndexPackets
+if applicable for the image type) from the image to the pixel cache as
 defined by the specified region:</p>
 <pre class="literal-block">
 const PixelPacket* getConstPixels ( const int x_, const int y_,
@@ -2949,24 +2950,28 @@
 </div>
 <div class="section" id="getindexes">
 <h2><a class="toc-backref" href="#id222">getIndexes</a></h2>
-<p>Obtain mutable image pixel indexes (valid for PseudoClass images):</p>
+<p>Obtain mutable image pixel indexes (valid for PseudoClass images). The
+selected region is defined by the prior getPixels(), getConstPixels(),
+or setPixels() call:</p>
 <pre class="literal-block">
 IndexPacket* getIndexes ( void )
 </pre>
 </div>
 <div class="section" id="getconstindexes">
 <h2><a class="toc-backref" href="#id223">getConstIndexes</a></h2>
-<p>Obtain immutable image pixel indexes (valid for PseudoClass images):</p>
+<p>Obtain immutable image pixel indexes (valid for PseudoClass
+images). The selected region is defined by the prior getPixels(),
+getConstPixels(), or setPixels() call:</p>
 <pre class="literal-block">
 const IndexPacket* getConstIndexes ( void ) const
 </pre>
 </div>
 <div class="section" id="getpixels">
 <h2><a class="toc-backref" href="#id224">getPixels</a></h2>
-<p>Transfers pixels from the image to the pixel cache as defined by the
-specified region. Modified pixels may be subsequently transferred back
-to the image via syncPixels.  This method is valid for DirectClass
-images:</p>
+<p>Transfers pixels (DirectClass PixelPackets, and IndexPackets if
+applicable for the image type) from the image to the pixel cache as
+defined by the specified region. Modified pixels may be subsequently
+transferred back to the image via syncPixels:</p>
 <pre class="literal-block">
 PixelPacket* getPixels ( const int x_, const int y_,
                          const unsigned int columns_,
diff -r eaa9f32ff59d -r f888dee94268 www/Magick++/Image.rst
--- a/www/Magick++/Image.rst	Sun May 08 11:09:42 2022 -0500
+++ b/www/Magick++/Image.rst	Sun May 08 18:40:47 2022 -0500
@@ -2753,7 +2753,8 @@
 getConstPixels
 ++++++++++++++
 
-Transfers read-only pixels from the image to the pixel cache as
+Transfers read-only pixels (DirectClass PixelPackets, and IndexPackets
+if applicable for the image type) from the image to the pixel cache as
 defined by the specified region::
 
     const PixelPacket* getConstPixels ( const int x_, const int y_,
@@ -2763,24 +2764,28 @@
 getIndexes
 ++++++++++
 
-Obtain mutable image pixel indexes (valid for PseudoClass images)::
+Obtain mutable image pixel indexes (valid for PseudoClass images). The
+selected region is defined by the prior getPixels(), getConstPixels(),
+or setPixels() call::
 
     IndexPacket* getIndexes ( void )
 
 getConstIndexes
 +++++++++++++++
 
-Obtain immutable image pixel indexes (valid for PseudoClass images)::
+Obtain immutable image pixel indexes (valid for PseudoClass
+images). The selected region is defined by the prior getPixels(),
+getConstPixels(), or setPixels() call::
 
     const IndexPacket* getConstIndexes ( void ) const
 
 getPixels
 +++++++++
 
-Transfers pixels from the image to the pixel cache as defined by the
-specified region. Modified pixels may be subsequently transferred back
-to the image via syncPixels.  This method is valid for DirectClass
-images::
+Transfers pixels (DirectClass PixelPackets, and IndexPackets if
+applicable for the image type) from the image to the pixel cache as
+defined by the specified region. Modified pixels may be subsequently
+transferred back to the image via syncPixels::
 
     PixelPacket* getPixels ( const int x_, const int y_,
                              const unsigned int columns_,
_______________________________________________
Graphicsmagick-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/graphicsmagick-commit