diff options
Diffstat (limited to 'lib/pygame/surfarray.py')
| -rwxr-xr-x | lib/pygame/surfarray.py | 340 |
1 files changed, 0 insertions, 340 deletions
diff --git a/lib/pygame/surfarray.py b/lib/pygame/surfarray.py deleted file mode 100755 index 33e2cb1..0000000 --- a/lib/pygame/surfarray.py +++ /dev/null @@ -1,340 +0,0 @@ -## pygame - Python Game Library -## Copyright (C) 2007 Marcus von Appen -## -## This library is free software; you can redistribute it and/or -## modify it under the terms of the GNU Library General Public -## License as published by the Free Software Foundation; either -## version 2 of the License, or (at your option) any later version. -## -## This library is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -## Library General Public License for more details. -## -## You should have received a copy of the GNU Library General Public -## License along with this library; if not, write to the Free -## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -## -## Marcus von Appen -## mva@sysfault.org - -"""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 types are - - numpy - numeric - -The default will be numpy, if installed. Otherwise, Numeric will be set -as default if installed. If neither numpy nor Numeric 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. -""" - -import pygame - -# Global array type setting. See use_arraytype(). -__arraytype = None - -# Try to import the necessary modules. -try: - import pygame._numpysurfarray as numpysf - __hasnumpy = True - __arraytype = "numpy" -except ImportError: - __hasnumpy = False - -try: - import pygame._numericsurfarray as numericsf - __hasnumeric = True - if not __hasnumpy: - __arraytype = "numeric" -except ImportError: - __hasnumeric = False - -if not __hasnumpy and not __hasnumeric: - raise ImportError("no module named numpy or Numeric found") - -from _arraysurfarray import blit_array - -def array2d (surface): - """pygame.surfarray.array2d (Surface): return array - - Copy pixels into a 2d 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). - """ - if __arraytype == "numeric": - return numericsf.array2d (surface) - elif __arraytype == "numpy": - return numpysf.array2d (surface) - raise NotImplementedError("surface arrays are not supported") - -def pixels2d (surface): - """pygame.surfarray.pixels2d (Surface): return array - - Reference pixels into a 2d 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). - """ - if __arraytype == "numeric": - return numericsf.pixels2d (surface) - elif __arraytype == "numpy": - return numpysf.pixels2d (surface) - raise NotImplementedError("surface arrays are not supported") - -def array3d (surface): - """pygame.surfarray.array3d (Surface): return array - - Copy pixels into a 3d 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). - """ - if __arraytype == "numeric": - return numericsf.array3d (surface) - elif __arraytype == "numpy": - return numpysf.array3d (surface) - raise NotImplementedError("surface arrays are not supported") - -def pixels3d (surface): - """pygame.surfarray.pixels3d (Surface): return array - - Reference pixels into a 3d 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). - """ - if __arraytype == "numeric": - return numericsf.pixels3d (surface) - elif __arraytype == "numpy": - return numpysf.pixels3d (surface) - raise NotImplementedError("surface arrays are not supported") - -def array_alpha (surface): - """pygame.surfarray.array_alpha (Surface): return array - - Copy pixel alphas into a 2d 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). - """ - if __arraytype == "numeric": - return numericsf.array_alpha (surface) - elif __arraytype == "numpy": - return numpysf.array_alpha (surface) - raise NotImplementedError("surface arrays are not supported") - -def pixels_alpha (surface): - """pygame.surfarray.pixels_alpha (Surface): return array - - Reference pixel alphas into a 2d 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. - """ - if __arraytype == "numeric": - return numericsf.pixels_alpha (surface) - elif __arraytype == "numpy": - return numpysf.pixels_alpha (surface) - raise NotImplementedError("surface arrays are not supported") - -def array_colorkey (surface): - """pygame.surfarray.array_colorkey (Surface): return array - - Copy the colorkey values into a 2d 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. - """ - if __arraytype == "numeric": - return numericsf.array_colorkey (surface) - elif __arraytype == "numpy": - return numpysf.array_colorkey (surface) - raise NotImplementedError("surface arrays are not supported") - -def make_surface (array): - """pygame.surfarray.make_surface (array): return Surface - - Copy an array to a new 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. - """ - if __arraytype == "numeric": - return numericsf.make_surface (array) - elif __arraytype == "numpy": - return numpysf.make_surface (array) - raise NotImplementedError("surface arrays are not supported") - -##def blit_array (surface, array): -## """pygame.surfarray.blit_array (Surface, array): return None -## -## Blit directly from a array values. -## -## 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. -## """ -## if __arraytype == "numeric": -## return numericsf.blit_array (surface, array) -## elif __arraytype == "numpy": -## return numpysf.blit_array (surface, array) -## raise NotImplementedError("surface arrays are not supported") - -def map_array (surface, array): - """pygame.surfarray.map_array (Surface, array3d): return array2d - - Map a 3D array into a 2D array. - - 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. - """ - if __arraytype == "numeric": - return numericsf.map_array (surface, array) - elif __arraytype == "numpy": - return numpysf.map_array (surface, array) - raise NotImplementedError("surface arrays are not supported") - -def use_arraytype (arraytype): - """pygame.surfarray.use_arraytype (arraytype): return None - - Sets the array system to be used for surface arrays. - - 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. - """ - global __arraytype - - arraytype = arraytype.lower () - if arraytype == "numeric": - if __hasnumeric: - __arraytype = arraytype - else: - raise ValueError("Numeric arrays are not available") - - elif arraytype == "numpy": - if __hasnumpy: - __arraytype = arraytype - else: - raise ValueError("numpy arrays are not available") - else: - raise ValueError("invalid array type") - -def get_arraytype (): - """pygame.surfarray.get_arraytype (): return str - - Gets the currently active array type. - - 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. - """ - return __arraytype - -def get_arraytypes (): - """pygame.surfarray.get_arraytypes (): return tuple - - Gets the array system types currently supported. - - Checks, which array system types are available and returns them as a - tuple of strings. The values of the tuple can be used directly in - the use_arraytype () method. - - If no supported array system could be found, None will be returned. - """ - vals = [] - if __hasnumeric: - vals.append ("numeric") - if __hasnumpy: - vals.append ("numpy") - if len (vals) == 0: - return None - return tuple (vals) - |