Mercurial > pygame
diff src/doc/pixelarray_doc.h @ 1849:301bc61643a9 math_module
merged changes from trunk
| author | lorenz |
|---|---|
| date | Mon, 16 Nov 2009 18:31:40 +0000 |
| parents | |
| children | da4302429d3b |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/doc/pixelarray_doc.h Mon Nov 16 18:31:40 2009 +0000 @@ -0,0 +1,58 @@ +/* Auto generated file: with makeref.py . Docs go in src/ *.doc . */ +#define DOC_PYGAMEPIXELARRAY "pygame.PixelArray(Surface): return PixelArray\npygame object for direct pixel access of surfaces" + +#define DOC_PIXELARRAYSURFACE "PixelArray.surface: Return Surface\nGets the Surface the PixelArray uses." + +#define DOC_PIXELARRAYMAKESURFACE "PixelArray.make_surface (): Return Surface\nCreates a new Surface from the current PixelArray." + +#define DOC_PIXELARRAYREPLACE "PixelArray.replace (color, repcolor, distance=0, weights=(0.299, 0.587, 0.114)): Return None\nReplaces the passed color in the PixelArray with another one." + +#define DOC_PIXELARRAYEXTRACT "PixelArray.extract (color, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray\nExtracts the passed color from the PixelArray." + +#define DOC_PIXELARRAYCOMPARE "PixelArray.compare (array, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray\nCompares the PixelArray with another one." + + + +/* Docs in a comments... slightly easier to read. */ + + +/* + +pygame.PixelArray + pygame.PixelArray(Surface): return PixelArray +pygame object for direct pixel access of surfaces + + + +PixelArray.surface + PixelArray.surface: Return Surface +Gets the Surface the PixelArray uses. + + + +PixelArray.make_surface + PixelArray.make_surface (): Return Surface +Creates a new Surface from the current PixelArray. + + + +PixelArray.replace + PixelArray.replace (color, repcolor, distance=0, weights=(0.299, 0.587, 0.114)): Return None +Replaces the passed color in the PixelArray with another one. + + + +PixelArray.extract + PixelArray.extract (color, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray +Extracts the passed color from the PixelArray. + + + +PixelArray.compare + PixelArray.compare (array, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray +Compares the PixelArray with another one. + + + +*/ +
