Mercurial > pygame

annotate src/doc/transform_doc.h @ 3172:d1b367fc08bc tests-returncode

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use a return code of 1 when the tests fail.
author Thomas Kluyver <takowl@gmail.com>
date Wed, 09 Jan 2013 10:13:57 +0000
parents da4302429d3b
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 . */
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
2 #define DOC_PYGAMETRANSFORM "pygame module to transform surfaces"
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: 2166
diff changeset
4 #define DOC_PYGAMETRANSFORMFLIP "flip(Surface, xbool, ybool) -> Surface\nflip vertically and horizontally"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
5
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
6 #define DOC_PYGAMETRANSFORMSCALE "scale(Surface, (width, height), DestSurface = None) -> Surface\nresize to new resolution"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
7
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
8 #define DOC_PYGAMETRANSFORMROTATE "rotate(Surface, angle) -> Surface\nrotate an image"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
9
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
10 #define DOC_PYGAMETRANSFORMROTOZOOM "rotozoom(Surface, angle, scale) -> Surface\nfiltered scale and rotation"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
11
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
12 #define DOC_PYGAMETRANSFORMSCALE2X "scale2x(Surface, DestSurface = None) -> Surface\nspecialized image doubler"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
13
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
14 #define DOC_PYGAMETRANSFORMSMOOTHSCALE "smoothscale(Surface, (width, height), DestSurface = None) -> Surface\nscale a surface to an arbitrary size smoothly"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
15
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
16 #define DOC_PYGAMETRANSFORMGETSMOOTHSCALEBACKEND "get_smoothscale_backend() -> String\nreturn smoothscale filter version in use: 'GENERIC', 'MMX', or 'SSE'"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
17
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
18 #define DOC_PYGAMETRANSFORMSETSMOOTHSCALEBACKEND "set_smoothscale_backend(type) -> None\nset smoothscale filter version to one of: 'GENERIC', 'MMX', or 'SSE'"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
19
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
20 #define DOC_PYGAMETRANSFORMCHOP "chop(Surface, rect) -> Surface\ngets a copy of an image with an interior area removed"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
21
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
22 #define DOC_PYGAMETRANSFORMLAPLACIAN "laplacian(Surface, DestSurface = None) -> Surface\nfind edges in a surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
23
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
24 #define DOC_PYGAMETRANSFORMAVERAGESURFACES "average_surfaces(Surfaces, DestSurface = None, palette_colors = 1) -> Surface\nfind the average surface from many surfaces."
1937
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: 2166
diff changeset
26 #define DOC_PYGAMETRANSFORMAVERAGECOLOR "average_color(Surface, Rect = None) -> Color\nfinds the average color of a surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
27
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
28 #define DOC_PYGAMETRANSFORMTHRESHOLD "threshold(DestSurface, Surface, color, threshold = (0,0,0,0), diff_color = (0,0,0,0), change_return = 1, Surface = None, inverse = False) -> num_threshold_pixels\nfinds which, and how many pixels in a surface are within a threshold of a color."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
29
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
30
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
31
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
32 /* Docs in a comment... slightly easier to read. */
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
33
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
34 /*
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
35
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
36 pygame.transform
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
37 pygame module to transform surfaces
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
38
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
39 pygame.transform.flip
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
40 flip(Surface, xbool, ybool) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
41 flip vertically and horizontally
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
42
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
43 pygame.transform.scale
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
44 scale(Surface, (width, height), DestSurface = None) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
45 resize to new resolution
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
46
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
47 pygame.transform.rotate
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
48 rotate(Surface, angle) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
49 rotate an image
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
50
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
51 pygame.transform.rotozoom
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
52 rotozoom(Surface, angle, scale) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
53 filtered scale and rotation
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
54
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
55 pygame.transform.scale2x
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
56 scale2x(Surface, DestSurface = None) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
57 specialized image doubler
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
58
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
59 pygame.transform.smoothscale
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
60 smoothscale(Surface, (width, height), DestSurface = None) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
61 scale a surface to an arbitrary size smoothly
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
62
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
63 pygame.transform.get_smoothscale_backend
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
64 get_smoothscale_backend() -> String
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
65 return smoothscale filter version in use: 'GENERIC', 'MMX', or 'SSE'
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
66
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
67 pygame.transform.set_smoothscale_backend
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
68 set_smoothscale_backend(type) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
69 set smoothscale filter version to one of: 'GENERIC', 'MMX', or 'SSE'
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
70
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
71 pygame.transform.chop
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
72 chop(Surface, rect) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
73 gets a copy of an image with an interior area removed
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
74
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
75 pygame.transform.laplacian
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
76 laplacian(Surface, DestSurface = None) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
77 find edges in a surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
78
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
79 pygame.transform.average_surfaces
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
80 average_surfaces(Surfaces, DestSurface = None, palette_colors = 1) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
81 find the average surface from many surfaces.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
82
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
83 pygame.transform.average_color
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
84 average_color(Surface, Rect = None) -> Color
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
85 finds the average color of a surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
86
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
87 pygame.transform.threshold
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
88 threshold(DestSurface, Surface, color, threshold = (0,0,0,0), diff_color = (0,0,0,0), change_return = 1, Surface = None, inverse = False) -> num_threshold_pixels
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
89 finds which, and how many pixels in a surface are within a threshold of a color.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
90
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
91 */