diff docs/ref/pixelarray.html @ 2245:5a558a74e434

Add note to PixelArray doc about future indend changes that will break PixelArray to PixelArray assignments in some cases
author Lenard Lindstrom <len-l@telus.net>
date Mon, 06 Jun 2011 21:30:11 +0000
parents be3228f63883
children 0a3be7313aa4
line wrap: on
line diff
--- a/docs/ref/pixelarray.html	Mon Jun 06 19:31:38 2011 +0000
+++ b/docs/ref/pixelarray.html	Mon Jun 06 21:30:11 2011 +0000
@@ -212,6 +212,15 @@
 <span class="n">pxarray</span><span class="p">[</span><span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>                <span class="c"># Same as pxarray[:]</span>
 </pre></div>
 </div>
+<p>A note about PixelArray to PixelArray assignment, for arrays with an
+item size of 3 (created from 24 bit surfaces) pixel values are translated
+from the source to the destinations format. The red, green, and blue
+color elements of each pixel are shifted to match the format of the
+target surface. For all other pixel sizes no such remapping occurs.
+This should change in later Pygame releases, where format conversions
+are performed for all pixel sizes. To avoid code breakage when full mapped
+copying is implemented it is suggested PixelArray to PixelArray copies be
+only between surfaces of identical format.</p>
 <p>New in pygame 1.9.2</p>
 <blockquote>
 <div><ul class="simple">