Source

pygame / src / doc / surfarray_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMESURFARRAY "pygame module for accessing surface pixel data using array interfaces"

#define DOC_PYGAMESURFARRAYARRAY2D "pygame.surfarray.array2d(Surface): return array\nCopy pixels into a 2d array"

#define DOC_PYGAMESURFARRAYPIXELS2D "pygame.surfarray.pixels2d(Surface): return array\nReference pixels into a 2d array"

#define DOC_PYGAMESURFARRAYARRAY3D "pygame.surfarray.array3d(Surface): return array\nCopy pixels into a 3d array"

#define DOC_PYGAMESURFARRAYPIXELS3D "pygame.surfarray.pixels3d(Surface): return array\nReference pixels into a 3d array"

#define DOC_PYGAMESURFARRAYARRAYALPHA "pygame.surfarray.array_alpha(Surface): return array\nCopy pixel alphas into a 2d array"

#define DOC_PYGAMESURFARRAYPIXELSALPHA "pygame.surfarray.pixels_alpha(Surface): return array\nReference pixel alphas into a 2d array"

#define DOC_PYGAMESURFARRAYARRAYCOLORKEY "pygame.surfarray.array_colorkey(Surface): return array\nCopy the colorkey values into a 2d array"

#define DOC_PYGAMESURFARRAYMAKESURFACE "pygame.surfarray.make_surface(array): return Surface\nCopy an array to a new surface"

#define DOC_PYGAMESURFARRAYBLITARRAY "pygame.surfarray.blit_array(Surface, array): return None\nBlit directly from a array values"

#define DOC_PYGAMESURFARRAYMAPARRAY "pygame.surfarray.map_array(Surface, array3d): return array2d\nMap a 3d array into a 2d array"

#define DOC_PYGAMESURFARRAYUSEARRAYTYPE "pygame.surfarray.use_arraytype (arraytype): return None\nSets the array system to be used for surface arrays"

#define DOC_PYGAMESURFARRAYGETARRAYTYPE "pygame.surfarray.get_arraytype (): return str\nGets the currently active array type."

#define DOC_PYGAMESURFARRAYGETARRAYTYPES "pygame.surfarray.get_arraytypes (): return tuple\nGets the array system types currently supported."



/* Docs in a comments... slightly easier to read. */


/*

pygame.surfarray
 pygame module for accessing surface pixel data using array interfaces



pygame.surfarray.array2d
 pygame.surfarray.array2d(Surface): return array
Copy pixels into a 2d array



pygame.surfarray.pixels2d
 pygame.surfarray.pixels2d(Surface): return array
Reference pixels into a 2d array



pygame.surfarray.array3d
 pygame.surfarray.array3d(Surface): return array
Copy pixels into a 3d array



pygame.surfarray.pixels3d
 pygame.surfarray.pixels3d(Surface): return array
Reference pixels into a 3d array



pygame.surfarray.array_alpha
 pygame.surfarray.array_alpha(Surface): return array
Copy pixel alphas into a 2d array



pygame.surfarray.pixels_alpha
 pygame.surfarray.pixels_alpha(Surface): return array
Reference pixel alphas into a 2d array



pygame.surfarray.array_colorkey
 pygame.surfarray.array_colorkey(Surface): return array
Copy the colorkey values into a 2d array



pygame.surfarray.make_surface
 pygame.surfarray.make_surface(array): return Surface
Copy an array to a new surface



pygame.surfarray.blit_array
 pygame.surfarray.blit_array(Surface, array): return None
Blit directly from a array values



pygame.surfarray.map_array
 pygame.surfarray.map_array(Surface, array3d): return array2d
Map a 3d array into a 2d array



pygame.surfarray.use_arraytype
 pygame.surfarray.use_arraytype (arraytype): return None
Sets the array system to be used for surface arrays



pygame.surfarray.get_arraytype
 pygame.surfarray.get_arraytype (): return str
Gets the currently active array type.



pygame.surfarray.get_arraytypes
 pygame.surfarray.get_arraytypes (): return tuple
Gets the array system types currently supported.



*/