Mercurial > pygame

annotate src/pixelarray.doc @ 870:31fa129efd0f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed Mask documentation. Added write() method to BufferProxy.
author marcus
date Wed, 02 Jan 2008 11:36:57 +0000
parents ba268d059b00
children 5f702ba03cc1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
852
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
1 pygame.PixelArray
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
2 pygame Object for direct pixel access of surfaces
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
3 pygame.PixelArray(surface): return PixelArray
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
4
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
5 The PixelArray wraps up a Surface and provides a direct 2D array access
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
6 to its pixels using the surface its rows as first and its columns as
866
ba268d059b00 Fixed exception messages in PixelArray. Added unit tests for PixelArray. Fixed doc strings for PixelArray.
marcus
parents: 852
diff changeset
7 second axis. It supports slicing, row and pixel manipluation while
ba268d059b00 Fixed exception messages in PixelArray. Added unit tests for PixelArray. Fixed doc strings for PixelArray.
marcus
parents: 852
diff changeset
8 inplace operations such as addition, subtraction, multiplication,
ba268d059b00 Fixed exception messages in PixelArray. Added unit tests for PixelArray. Fixed doc strings for PixelArray.
marcus
parents: 852
diff changeset
9 division and slice assignments are not allowed.
852
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
10
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
11 During its lifetime, the PixelArray locks the surface, thus you
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
12 explicitly have to delete it once its not used anymore and the surface
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
13 should perform operations in the same scope.
870
31fa129efd0f Fixed Mask documentation. Added write() method to BufferProxy.
marcus
parents: 866
diff changeset
14 <SECTION>
852
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
15
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
16
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
17 surface
870
31fa129efd0f Fixed Mask documentation. Added write() method to BufferProxy.
marcus
parents: 866
diff changeset
18 Gets the Surface the PixelArray uses.
852
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
19 PixelArray.surface: Return Surface
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
20
870
31fa129efd0f Fixed Mask documentation. Added write() method to BufferProxy.
marcus
parents: 866
diff changeset
21 The Surface, the PixelArray was created for.
852
4db78800a93a A PixelArray class, which is meant to replace surfarray.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
22 <END>