comparison 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
comparison
equal deleted inserted replaced
1848:bbc21cd6faeb 1849:301bc61643a9
1 /* Auto generated file: with makeref.py . Docs go in src/ *.doc . */
2 #define DOC_PYGAMEPIXELARRAY "pygame.PixelArray(Surface): return PixelArray\npygame object for direct pixel access of surfaces"
3
4 #define DOC_PIXELARRAYSURFACE "PixelArray.surface: Return Surface\nGets the Surface the PixelArray uses."
5
6 #define DOC_PIXELARRAYMAKESURFACE "PixelArray.make_surface (): Return Surface\nCreates a new Surface from the current PixelArray."
7
8 #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."
9
10 #define DOC_PIXELARRAYEXTRACT "PixelArray.extract (color, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray\nExtracts the passed color from the PixelArray."
11
12 #define DOC_PIXELARRAYCOMPARE "PixelArray.compare (array, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray\nCompares the PixelArray with another one."
13
14
15
16 /* Docs in a comments... slightly easier to read. */
17
18
19 /*
20
21 pygame.PixelArray
22 pygame.PixelArray(Surface): return PixelArray
23 pygame object for direct pixel access of surfaces
24
25
26
27 PixelArray.surface
28 PixelArray.surface: Return Surface
29 Gets the Surface the PixelArray uses.
30
31
32
33 PixelArray.make_surface
34 PixelArray.make_surface (): Return Surface
35 Creates a new Surface from the current PixelArray.
36
37
38
39 PixelArray.replace
40 PixelArray.replace (color, repcolor, distance=0, weights=(0.299, 0.587, 0.114)): Return None
41 Replaces the passed color in the PixelArray with another one.
42
43
44
45 PixelArray.extract
46 PixelArray.extract (color, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray
47 Extracts the passed color from the PixelArray.
48
49
50
51 PixelArray.compare
52 PixelArray.compare (array, distance=0, weights=(0.299, 0.587, 0.114)): Return PixelArray
53 Compares the PixelArray with another one.
54
55
56
57 */
58