• R/O
  • SSH

GM: Commit

Main GraphicsMagick source repository


Commit MetaInfo

Revisionf888dee94268f0ecf62624a3ffcf798f9d78e245 (tree)
Time2022-05-09 08:40:47
AuthorBob Friesenhahn <bfriesen@Grap...>
CommiterBob Friesenhahn

Log Message

Magick++: Update getIndexes() and getConstIndexes() documention to mention that the selected region is defined by a prior getPixels(), getConstPixels(), or setPixels() call.

Change Summary

Incremental Difference

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 @@
11 2022-05-08 Bob Friesenhahn <bfriesen@simple.dallas.tx.us>
22
3+ * www/Magick++/Image.rst: Update getIndexes() and
4+ getConstIndexes() documention to mention that the selected region
5+ is defined by a prior getPixels(), getConstPixels(), or
6+ setPixels() call. This is inspired by private email from Miro
7+ Kropáček on May 8, 2022.
8+
39 * coders/jpeg.c (WriteJPEGImage): Change "arithmetic" to
410 "arithmetic-coding" in order to match ImageMagick's previously
511 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 @@
13051305
13061306
13071307 // Transfers read-only pixels from the image to the pixel cache as
1308- // defined by the specified region
1308+ // defined by the specified region.
13091309 const PixelPacket* getConstPixels ( const int x_, const int y_,
13101310 const unsigned int columns_,
13111311 const unsigned int rows_ ) const;
13121312
1313- // Obtain mutable image pixel indexes (valid for PseudoClass images)
1313+ // Obtain mutable image pixel indexes (valid for PseudoClass
1314+ // images). The selected region is defined by the prior
1315+ // getPixels(), getConstPixels(), or setPixels() call.
13141316 IndexPacket* getIndexes ( void );
13151317
1316- // Obtain immutable image pixel indexes (valid for PseudoClass images)
1318+ // Obtain immutable image pixel indexes (valid for PseudoClass
1319+ // images). The selected region is defined by a prior getPixels(),
1320+ // getConstPixels(), or setPixels() call.
13171321 const IndexPacket* getConstIndexes ( void ) const;
13181322
13191323 // Transfers pixels from the image to the pixel cache as defined
13201324 // by the specified region. Modified pixels may be subsequently
1321- // transferred back to the image via syncPixels. This method is
1322- // valid for DirectClass images.
1325+ // transferred back to the image via syncPixels.
13231326 PixelPacket* getPixels ( const int x_, const int y_,
13241327 const unsigned int columns_,
13251328 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 @@
3737
3838 <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>
3939 <blockquote>
40+<p>* www/Magick++/Image.rst: Update getIndexes() and
41+getConstIndexes() documention to mention that the selected region
42+is defined by a prior getPixels(), getConstPixels(), or
43+setPixels() call. This is inspired by private email from Miro
44+Kropáček on May 8, 2022.</p>
4045 <p>* coders/jpeg.c (WriteJPEGImage): Change &quot;arithmetic&quot; to
4146 &quot;arithmetic-coding&quot; in order to match ImageMagick's previously
4247 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 @@
29392939 </div>
29402940 <div class="section" id="getconstpixels">
29412941 <h2><a class="toc-backref" href="#id221">getConstPixels</a></h2>
2942-<p>Transfers read-only pixels from the image to the pixel cache as
2942+<p>Transfers read-only pixels (DirectClass PixelPackets, and IndexPackets
2943+if applicable for the image type) from the image to the pixel cache as
29432944 defined by the specified region:</p>
29442945 <pre class="literal-block">
29452946 const PixelPacket* getConstPixels ( const int x_, const int y_,
@@ -2949,24 +2950,28 @@
29492950 </div>
29502951 <div class="section" id="getindexes">
29512952 <h2><a class="toc-backref" href="#id222">getIndexes</a></h2>
2952-<p>Obtain mutable image pixel indexes (valid for PseudoClass images):</p>
2953+<p>Obtain mutable image pixel indexes (valid for PseudoClass images). The
2954+selected region is defined by the prior getPixels(), getConstPixels(),
2955+or setPixels() call:</p>
29532956 <pre class="literal-block">
29542957 IndexPacket* getIndexes ( void )
29552958 </pre>
29562959 </div>
29572960 <div class="section" id="getconstindexes">
29582961 <h2><a class="toc-backref" href="#id223">getConstIndexes</a></h2>
2959-<p>Obtain immutable image pixel indexes (valid for PseudoClass images):</p>
2962+<p>Obtain immutable image pixel indexes (valid for PseudoClass
2963+images). The selected region is defined by the prior getPixels(),
2964+getConstPixels(), or setPixels() call:</p>
29602965 <pre class="literal-block">
29612966 const IndexPacket* getConstIndexes ( void ) const
29622967 </pre>
29632968 </div>
29642969 <div class="section" id="getpixels">
29652970 <h2><a class="toc-backref" href="#id224">getPixels</a></h2>
2966-<p>Transfers pixels from the image to the pixel cache as defined by the
2967-specified region. Modified pixels may be subsequently transferred back
2968-to the image via syncPixels. This method is valid for DirectClass
2969-images:</p>
2971+<p>Transfers pixels (DirectClass PixelPackets, and IndexPackets if
2972+applicable for the image type) from the image to the pixel cache as
2973+defined by the specified region. Modified pixels may be subsequently
2974+transferred back to the image via syncPixels:</p>
29702975 <pre class="literal-block">
29712976 PixelPacket* getPixels ( const int x_, const int y_,
29722977 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 @@
27532753 getConstPixels
27542754 ++++++++++++++
27552755
2756-Transfers read-only pixels from the image to the pixel cache as
2756+Transfers read-only pixels (DirectClass PixelPackets, and IndexPackets
2757+if applicable for the image type) from the image to the pixel cache as
27572758 defined by the specified region::
27582759
27592760 const PixelPacket* getConstPixels ( const int x_, const int y_,
@@ -2763,24 +2764,28 @@
27632764 getIndexes
27642765 ++++++++++
27652766
2766-Obtain mutable image pixel indexes (valid for PseudoClass images)::
2767+Obtain mutable image pixel indexes (valid for PseudoClass images). The
2768+selected region is defined by the prior getPixels(), getConstPixels(),
2769+or setPixels() call::
27672770
27682771 IndexPacket* getIndexes ( void )
27692772
27702773 getConstIndexes
27712774 +++++++++++++++
27722775
2773-Obtain immutable image pixel indexes (valid for PseudoClass images)::
2776+Obtain immutable image pixel indexes (valid for PseudoClass
2777+images). The selected region is defined by the prior getPixels(),
2778+getConstPixels(), or setPixels() call::
27742779
27752780 const IndexPacket* getConstIndexes ( void ) const
27762781
27772782 getPixels
27782783 +++++++++
27792784
2780-Transfers pixels from the image to the pixel cache as defined by the
2781-specified region. Modified pixels may be subsequently transferred back
2782-to the image via syncPixels. This method is valid for DirectClass
2783-images::
2785+Transfers pixels (DirectClass PixelPackets, and IndexPackets if
2786+applicable for the image type) from the image to the pixel cache as
2787+defined by the specified region. Modified pixels may be subsequently
2788+transferred back to the image via syncPixels::
27842789
27852790 PixelPacket* getPixels ( const int x_, const int y_,
27862791 const unsigned int columns_,
Show on old repository browser