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