Mercurial > pygame

annotate src/doc/pixelarray_doc.h @ 3194:9fcb7abf3185 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Remove some gcc 4.7.2 compiler warnings
author Lenard Lindstrom <len-l@telus.net>
date Tue, 23 Apr 2013 19:53:36 -0700
parents be3228f63883
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
1 /* Auto generated file: with makeref.py . Docs go in src/ *.doc . */
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
2 #define DOC_PYGAMEPIXELARRAY "PixelArray(Surface) -> PixelArray\npygame object for direct pixel access of surfaces"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
3
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
4 #define DOC_PIXELARRAYSURFACE "surface -> Surface\nGets the Surface the PixelArray uses."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
5
2218
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
6 #define DOC_PIXELARRAYITEMSIZE "itemsize -> int\nReturns the byte size of a pixel array item"
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
7
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
8 #define DOC_PIXELARRAYNDIM "ndim -> int\nReturns the number of dimensions."
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
9
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
10 #define DOC_PIXELARRAYSHAPE "shape -> tuple of int's\nReturns the array size."
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
11
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
12 #define DOC_PIXELARRAYSTRIDES "strides -> tuple of int's\nReturns byte offsets for each array dimension."
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
13
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
14 #define DOC_PIXELARRAYMAKESURFACE "make_surface() -> Surface\nCreates a new Surface from the current PixelArray."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
15
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
16 #define DOC_PIXELARRAYREPLACE "replace(color, repcolor, distance=0, weights=(0.299, 0.587, 0.114)) -> None\nReplaces the passed color in the PixelArray with another one."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
17
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
18 #define DOC_PIXELARRAYEXTRACT "extract(color, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray\nExtracts the passed color from the PixelArray."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
19
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
20 #define DOC_PIXELARRAYCOMPARE "compare(array, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray\nCompares the PixelArray with another one."
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
21
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
22 #define DOC_PIXELARRAYTRANSPOSE "transpose() -> PixelArray\nExchanges the x and y axis."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
23
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
24
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
25
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
26 /* Docs in a comment... slightly easier to read. */
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
27
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
28 /*
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
29
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
30 pygame.PixelArray
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
31 PixelArray(Surface) -> PixelArray
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
32 pygame object for direct pixel access of surfaces
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
33
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
34 pygame.PixelArray.surface
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
35 surface -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
36 Gets the Surface the PixelArray uses.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
37
2218
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
38 pygame.PixelArray.itemsize
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
39 itemsize -> int
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
40 Returns the byte size of a pixel array item
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
41
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
42 pygame.PixelArray.ndim
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
43 ndim -> int
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
44 Returns the number of dimensions.
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
45
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
46 pygame.PixelArray.shape
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
47 shape -> tuple of int's
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
48 Returns the array size.
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
49
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
50 pygame.PixelArray.strides
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
51 strides -> tuple of int's
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
52 Returns byte offsets for each array dimension.
7b81f1162a96 Add an array struct interface and the ndim, itemsize, shape, strides, and _pixels_address properties.
Lenard Lindstrom <len-l@telus.net>
parents: 2198
diff changeset
53
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
54 pygame.PixelArray.make_surface
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
55 make_surface() -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
56 Creates a new Surface from the current PixelArray.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
57
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
58 pygame.PixelArray.replace
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
59 replace(color, repcolor, distance=0, weights=(0.299, 0.587, 0.114)) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
60 Replaces the passed color in the PixelArray with another one.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
61
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
62 pygame.PixelArray.extract
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
63 extract(color, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
64 Extracts the passed color from the PixelArray.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
65
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
66 pygame.PixelArray.compare
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
67 compare(array, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
68 Compares the PixelArray with another one.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
69
2240
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
70 pygame.PixelArray.transpose
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
71 transpose() -> PixelArray
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
72 Exchanges the x and y axis.
be3228f63883 Make PixelArray more internally consistent
Lenard Lindstrom <len-l@telus.net>
parents: 2218
diff changeset
73
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
74 */