1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
pygame.surfarray
pygame module for accessing surface pixel data using array interfaces
Functions to convert pixel data between pygame Surfaces and arrays. This
module will only be functional when pygame can use the external Numpy or
Numeric packages.
Every pixel is stored as a single integer value to represent the red,
green, and blue colors. The 8bit images use a value that looks into a
colormap. Pixels with higher depth use a bit packing process to place
three or four values into a single number.
The arrays are indexed by the X axis first, followed by the Y
axis. Arrays that treat the pixels as a single integer are referred to
as 2D arrays. This module can also separate the red, green, and blue
color values into separate indices. These types of arrays are referred
to as 3D arrays, and the last index is 0 for red, 1 for green, and 2 for
blue.
Supported array systems are
numeric
numpy
The default will be Numeric, if installed. Otherwise, numpy will be set
as default if installed. If neither Numeric nor numpy are installed, the
module will raise an ImportError.
The array type to use can be changed at runtime using the use_arraytype ()
method, which requires one of the above types as string.
Note: numpy and Numeric are not completely compatible. Certain array
manipulations, which work for one type, might behave differently or even
completely break for the other.
Additionally, in contrast to Numeric numpy does use unsigned 16-bit
integers. Images with 16-bit data will be treated as unsigned
integers. Numeric instead uses signed integers for the representation,
which is important to keep in mind, if you use the module's functions
and wonder about the values.
The support of numpy is new in pygame 1.8.
<SECTION>
array2d
Copy pixels into a 2d array
pygame.surfarray.array2d(Surface): return array
Copy the pixels from a Surface into a 2D array. The bit depth of the
surface will control the size of the integer values, and will work for
any type of pixel format.
This function will temporarily lock the Surface as pixels are copied
(see the Surface.lock - lock the Surface memory for pixel access
method).
<END>
pixels2d
Reference pixels into a 2d array
pygame.surfarray.pixels2d(Surface): return array
Create a new 2D array that directly references the pixel values in a
Surface. Any changes to the array will affect the pixels in the
Surface. This is a fast operation since no data is copied.
Pixels from a 24-bit Surface cannot be referenced, but all other Surface
bit depths can.
The Surface this references will remain locked for the lifetime of the
array (see the Surface.lock - lock the Surface memory for pixel access
method).
<END>
array3d
Copy pixels into a 3d array
pygame.surfarray.array3d(Surface): return array
Copy the pixels from a Surface into a 3D array. The bit depth of the
surface will control the size of the integer values, and will work for
any type of pixel format.
This function will temporarily lock the Surface as pixels are copied
(see the Surface.lock - lock the Surface memory for pixel access
method).
<END>
pixels3d
Reference pixels into a 3d array
pygame.surfarray.pixels3d(Surface): return array
Create a new 3D array that directly references the pixel values in a
Surface. Any changes to the array will affect the pixels in the
Surface. This is a fast operation since no data is copied.
This will only work on Surfaces that have 24-bit or 32-bit
formats. Lower pixel formats cannot be referenced.
The Surface this references will remain locked for the lifetime of the
array (see the Surface.lock - lock the Surface memory for pixel access
method).
<END>
array_alpha
Copy pixel alphas into a 2d array
pygame.surfarray.array_alpha(Surface): return array
Copy the pixel alpha values (degree of transparency) from a Surface into
a 2D array. This will work for any type of Surface format. Surfaces
without a pixel alpha will return an array with all opaque values.
This function will temporarily lock the Surface as pixels are copied
(see the Surface.lock - lock the Surface memory for pixel access
method).
<END>
pixels_alpha
Reference pixel alphas into a 2d array
pygame.surfarray.pixels_alpha(Surface): return array
Create a new 2D array that directly references the alpha values (degree
of transparency) in a Surface. Any changes to the array will affect the
pixels in the Surface. This is a fast operation since no data is copied.
This can only work on 32-bit Surfaces with a per-pixel alpha value.
The Surface this array references will remain locked for the lifetime of
the array.
<END>
array_colorkey
Copy the colorkey values into a 2d array
pygame.surfarray.array_colorkey(Surface): return array
Create a new array with the colorkey transparency value from each
pixel. If the pixel matches the colorkey it will be fully tranparent;
otherwise it will be fully opaque.
This will work on any type of Surface format. If the image has no
colorkey a solid opaque array will be returned.
This function will temporarily lock the Surface as pixels are copied.
<END>
make_surface
Copy an array to a new surface
pygame.surfarray.make_surface(array): return Surface
Create a new Surface that best resembles the data and format on the
array. The array can be 2D or 3D with any sized integer values.
<END>
blit_array
Blit directly from a array values
pygame.surfarray.blit_array(Surface, array): return None
Directly copy values from an array into a Surface. This is faster than
converting the array into a Surface and blitting. The array must be the
same dimensions as the Surface and will completely replace all pixel
values.
This function will temporarily lock the Surface as the new values are
copied.
<END>
map_array
Map a 3d array into a 2d array
pygame.surfarray.map_array(Surface, array3d): return array2d
Convert a 3D array into a 2D array. This will use the given Surface
format to control the conversion. Palette surface formats are not
supported.
<END>
use_arraytype
Sets the array system to be used for surface arrays
pygame.surfarray.use_arraytype (arraytype): return None
Uses the requested array type for the module functions.
Currently supported array types are:
numeric
numpy
If the requested type is not available, a ValueError will be raised.
New in pygame 1.8.
<END>
get_arraytype
Gets the currently active array type.
pygame.surfarray.get_arraytype (): return str
Returns the currently active array type. This will be a value of the
get_arraytypes() tuple and indicates which type of array module is used
for the array creation.
New in pygame 1.8
<END>
get_arraytypes
Gets the array system types currently supported.
pygame.surfarray.get_arraytypes (): return tuple
Checks, which array systems are available and returns them as a tuple of
strings. The values of the tuple can be used directly in the
pygame.surfarray.use_arraytype () method. If no supported array system could
be found, None will be returned.
New in pygame 1.8.
<END>
<END>
|
