Main GraphicsMagick source repository
Revisão | f888dee94268f0ecf62624a3ffcf798f9d78e245 (tree) |
---|---|
Hora | 2022-05-09 08:40:47 |
Autor | Bob Friesenhahn <bfriesen@Grap...> |
Commiter | Bob Friesenhahn |
Magick++: Update getIndexes() and getConstIndexes() documention to mention that the selected region is defined by a prior getPixels(), getConstPixels(), or setPixels() call.
@@ -1,5 +1,11 @@ | ||
1 | 1 | 2022-05-08 Bob Friesenhahn <bfriesen@simple.dallas.tx.us> |
2 | 2 | |
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 | + | |
3 | 9 | * coders/jpeg.c (WriteJPEGImage): Change "arithmetic" to |
4 | 10 | "arithmetic-coding" in order to match ImageMagick's previously |
5 | 11 | existing syntax. |
@@ -1305,21 +1305,24 @@ | ||
1305 | 1305 | |
1306 | 1306 | |
1307 | 1307 | // Transfers read-only pixels from the image to the pixel cache as |
1308 | - // defined by the specified region | |
1308 | + // defined by the specified region. | |
1309 | 1309 | const PixelPacket* getConstPixels ( const int x_, const int y_, |
1310 | 1310 | const unsigned int columns_, |
1311 | 1311 | const unsigned int rows_ ) const; |
1312 | 1312 | |
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. | |
1314 | 1316 | IndexPacket* getIndexes ( void ); |
1315 | 1317 | |
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. | |
1317 | 1321 | const IndexPacket* getConstIndexes ( void ) const; |
1318 | 1322 | |
1319 | 1323 | // Transfers pixels from the image to the pixel cache as defined |
1320 | 1324 | // 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. | |
1323 | 1326 | PixelPacket* getPixels ( const int x_, const int y_, |
1324 | 1327 | const unsigned int columns_, |
1325 | 1328 | const unsigned int rows_ ); |
@@ -37,6 +37,11 @@ | ||
37 | 37 | |
38 | 38 | <p>2022-05-08 Bob Friesenhahn <<a class="reference external" href="mailto:bfriesen%40simple.dallas.tx.us">bfriesen<span>@</span>simple<span>.</span>dallas<span>.</span>tx<span>.</span>us</a>></p> |
39 | 39 | <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> | |
40 | 45 | <p>* coders/jpeg.c (WriteJPEGImage): Change "arithmetic" to |
41 | 46 | "arithmetic-coding" in order to match ImageMagick's previously |
42 | 47 | existing syntax.</p> |
@@ -2939,7 +2939,8 @@ | ||
2939 | 2939 | </div> |
2940 | 2940 | <div class="section" id="getconstpixels"> |
2941 | 2941 | <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 | |
2943 | 2944 | defined by the specified region:</p> |
2944 | 2945 | <pre class="literal-block"> |
2945 | 2946 | const PixelPacket* getConstPixels ( const int x_, const int y_, |
@@ -2949,24 +2950,28 @@ | ||
2949 | 2950 | </div> |
2950 | 2951 | <div class="section" id="getindexes"> |
2951 | 2952 | <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> | |
2953 | 2956 | <pre class="literal-block"> |
2954 | 2957 | IndexPacket* getIndexes ( void ) |
2955 | 2958 | </pre> |
2956 | 2959 | </div> |
2957 | 2960 | <div class="section" id="getconstindexes"> |
2958 | 2961 | <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> | |
2960 | 2965 | <pre class="literal-block"> |
2961 | 2966 | const IndexPacket* getConstIndexes ( void ) const |
2962 | 2967 | </pre> |
2963 | 2968 | </div> |
2964 | 2969 | <div class="section" id="getpixels"> |
2965 | 2970 | <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> | |
2970 | 2975 | <pre class="literal-block"> |
2971 | 2976 | PixelPacket* getPixels ( const int x_, const int y_, |
2972 | 2977 | const unsigned int columns_, |
@@ -2753,7 +2753,8 @@ | ||
2753 | 2753 | getConstPixels |
2754 | 2754 | ++++++++++++++ |
2755 | 2755 | |
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 | |
2757 | 2758 | defined by the specified region:: |
2758 | 2759 | |
2759 | 2760 | const PixelPacket* getConstPixels ( const int x_, const int y_, |
@@ -2763,24 +2764,28 @@ | ||
2763 | 2764 | getIndexes |
2764 | 2765 | ++++++++++ |
2765 | 2766 | |
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:: | |
2767 | 2770 | |
2768 | 2771 | IndexPacket* getIndexes ( void ) |
2769 | 2772 | |
2770 | 2773 | getConstIndexes |
2771 | 2774 | +++++++++++++++ |
2772 | 2775 | |
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:: | |
2774 | 2779 | |
2775 | 2780 | const IndexPacket* getConstIndexes ( void ) const |
2776 | 2781 | |
2777 | 2782 | getPixels |
2778 | 2783 | +++++++++ |
2779 | 2784 | |
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:: | |
2784 | 2789 | |
2785 | 2790 | PixelPacket* getPixels ( const int x_, const int y_, |
2786 | 2791 | const unsigned int columns_, |