Mercurial > pygame
annotate src/doc/examples_doc.h @ 3172:d1b367fc08bc tests-returncode
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 |
| rev | line source |
|---|---|
| 1937 | 1 /* Auto generated file: with makeref.py . Docs go in src/ *.doc . */ |
| 2 #define DOC_PYGAMEEXAMPLES "module of example programs" | |
| 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_PYGAMEEXAMPLESALIENSMAIN "aliens.main() -> None\nplay the full aliens example" |
| 1937 | 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_PYGAMEEXAMPLESOLDALIENMAIN "oldalien.main() -> None\nplay the original aliens example" |
| 1937 | 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_PYGAMEEXAMPLESSTARSMAIN "stars.main() -> None\nrun a simple starfield example" |
| 1937 | 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_PYGAMEEXAMPLESCHIMPMAIN "chimp.main() -> None\nhit the moving chimp" |
| 1937 | 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_PYGAMEEXAMPLESMOVEITMAIN "moveit.main() -> None\ndisplay animated objects on the screen" |
| 1937 | 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_PYGAMEEXAMPLESFONTYMAIN "fonty.main() -> None\nrun a font rendering example" |
| 1937 | 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_PYGAMEEXAMPLESVGRADEMAIN "vgrade.main() -> None\ndisplay a vertical gradient" |
| 1937 | 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_PYGAMEEXAMPLESEVENTLISTMAIN "eventlist.main() -> None\ndisplay pygame events" |
| 1937 | 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_PYGAMEEXAMPLESARRAYDEMOMAIN "arraydemo.main(arraytype=None) -> None\nshow various surfarray effects" |
| 1937 | 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_PYGAMEEXAMPLESSOUNDMAIN "sound.main(file_path=None) -> None\nload and play a sound" |
| 1937 | 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_PYGAMEEXAMPLESSOUNDARRAYDEMOSMAIN "sound_array_demos.main(arraytype=None) -> None\nplay various sndarray effects" |
| 1937 | 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_PYGAMEEXAMPLESLIQUIDMAIN "liquid.main() -> None\ndisplay an animated liquid effect" |
| 1937 | 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_PYGAMEEXAMPLESGLCUBEMAIN "glcube.main() -> None\ndisplay an animated 3D cube using OpenGL" |
| 1937 | 29 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
30 #define DOC_PYGAMEEXAMPLESSCRAPCLIPBOARDMAIN "scrap_clipboard.main() -> None\naccess the clipboard" |
| 1937 | 31 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
32 #define DOC_PYGAMEEXAMPLESMASKMAIN "mask.main(*args) -> None\ndisplay multiple images bounce off each other using collision detection" |
| 1937 | 33 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
34 #define DOC_PYGAMEEXAMPLESTESTSPRITEMAIN "testsprite.main(update_rects = True, use_static = False, use_FastRenderGroup = False, screen_dims = [640, 480], use_alpha = False, flags = 0) -> None\nshow lots of sprites moving around" |
| 1937 | 35 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
36 #define DOC_PYGAMEEXAMPLESHEADLESSNOWINDOWSNEEDEDMAIN "headless_no_windows_needed.main(fin, fout, w, h) -> None\nwrite an image file that is smoothscaled copy of an input file" |
| 1937 | 37 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
38 #define DOC_PYGAMEEXAMPLESFASTEVENTSMAIN "fastevents.main() -> None\nstress test the fastevents module" |
| 1937 | 39 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
40 #define DOC_PYGAMEEXAMPLESOVERLAYMAIN "overlay.main(fname) -> None\nplay a .pgm video using overlays" |
| 1937 | 41 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
42 #define DOC_PYGAMEEXAMPLESBLENDFILLMAIN "blend_fill.main() -> None\ndemonstrate the various surface.fill method blend options" |
| 1937 | 43 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
44 #define DOC_PYGAMEEXAMPLESBLITBLENDSMAIN "blit_blends.main() -> None\nuses alternative additive fill to that of surface.fill" |
|
2147
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
45 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
46 #define DOC_PYGAMEEXAMPLESCURSORSMAIN "cursors.main() -> None\ndisplay two different custom cursors" |
| 1937 | 47 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
48 #define DOC_PYGAMEEXAMPLESPIXELARRAYMAIN "pixelarray.main() -> None\ndisplay various pixelarray generated effects" |
| 1937 | 49 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
50 #define DOC_PYGAMEEXAMPLESSCALETESTMAIN "scaletest.main(imagefile, convert_alpha=False, run_speed_test=True) -> None\ninteractively scale an image using smoothscale" |
| 1937 | 51 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
52 #define DOC_PYGAMEEXAMPLESMIDIMAIN "midi.main(mode='output', device_id=None) -> None\nrun a midi example" |
| 1937 | 53 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
54 #define DOC_PYGAMEEXAMPLESSCROLLMAIN "scroll.main(image_file=None) -> None\nrun a Surface.scroll example that shows a magnified image" |
| 1937 | 55 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
56 #define DOC_PYGAMEEXAMPLESMOVIEPLAYERMAIN "movieplayer.main(filepath) -> None\nplay an MPEG movie" |
| 1937 | 57 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
58 #define DOC_PYGAMEEXAMPLESCAMERAMAIN "camera.main() -> None\ndisplay video captured live from an attached camera" |
|
2147
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
59 |
| 1937 | 60 |
| 61 | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
62 /* Docs in a comment... slightly easier to read. */ |
| 1937 | 63 |
| 64 /* | |
| 65 | |
| 66 pygame.examples | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
67 module of example programs |
| 1937 | 68 |
| 69 pygame.examples.aliens.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
70 aliens.main() -> None |
| 1937 | 71 play the full aliens example |
| 72 | |
| 73 pygame.examples.oldalien.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
74 oldalien.main() -> None |
| 1937 | 75 play the original aliens example |
| 76 | |
| 77 pygame.examples.stars.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
78 stars.main() -> None |
| 1937 | 79 run a simple starfield example |
| 80 | |
| 81 pygame.examples.chimp.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
82 chimp.main() -> None |
| 1937 | 83 hit the moving chimp |
| 84 | |
| 85 pygame.examples.moveit.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
86 moveit.main() -> None |
| 1937 | 87 display animated objects on the screen |
| 88 | |
| 89 pygame.examples.fonty.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
90 fonty.main() -> None |
| 1937 | 91 run a font rendering example |
| 92 | |
| 93 pygame.examples.vgrade.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
94 vgrade.main() -> None |
| 1937 | 95 display a vertical gradient |
| 96 | |
| 97 pygame.examples.eventlist.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
98 eventlist.main() -> None |
| 1937 | 99 display pygame events |
| 100 | |
| 101 pygame.examples.arraydemo.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
102 arraydemo.main(arraytype=None) -> None |
| 1937 | 103 show various surfarray effects |
| 104 | |
| 105 pygame.examples.sound.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
106 sound.main(file_path=None) -> None |
| 1937 | 107 load and play a sound |
| 108 | |
| 109 pygame.examples.sound_array_demos.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
110 sound_array_demos.main(arraytype=None) -> None |
| 1937 | 111 play various sndarray effects |
| 112 | |
| 113 pygame.examples.liquid.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
114 liquid.main() -> None |
| 1937 | 115 display an animated liquid effect |
| 116 | |
| 117 pygame.examples.glcube.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
118 glcube.main() -> None |
| 1937 | 119 display an animated 3D cube using OpenGL |
| 120 | |
| 121 pygame.examples.scrap_clipboard.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
122 scrap_clipboard.main() -> None |
| 1937 | 123 access the clipboard |
| 124 | |
| 125 pygame.examples.mask.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
126 mask.main(*args) -> None |
| 1937 | 127 display multiple images bounce off each other using collision detection |
| 128 | |
| 129 pygame.examples.testsprite.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
130 testsprite.main(update_rects = True, use_static = False, use_FastRenderGroup = False, screen_dims = [640, 480], use_alpha = False, flags = 0) -> None |
| 1937 | 131 show lots of sprites moving around |
| 132 | |
| 133 pygame.examples.headless_no_windows_needed.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
134 headless_no_windows_needed.main(fin, fout, w, h) -> None |
| 1937 | 135 write an image file that is smoothscaled copy of an input file |
| 136 | |
| 137 pygame.examples.fastevents.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
138 fastevents.main() -> None |
| 1937 | 139 stress test the fastevents module |
| 140 | |
| 141 pygame.examples.overlay.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
142 overlay.main(fname) -> None |
| 1937 | 143 play a .pgm video using overlays |
| 144 | |
| 145 pygame.examples.blend_fill.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
146 blend_fill.main() -> None |
| 1937 | 147 demonstrate the various surface.fill method blend options |
| 148 | |
|
2147
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
149 pygame.examples.blit_blends.main |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
150 blit_blends.main() -> None |
|
2147
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
151 uses alternative additive fill to that of surface.fill |
|
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
152 |
| 1937 | 153 pygame.examples.cursors.main |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
154 cursors.main() -> None |
| 1937 | 155 display two different custom cursors |
| 156 | |
| 157 pygame.examples.pixelarray.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
158 pixelarray.main() -> None |
| 1937 | 159 display various pixelarray generated effects |
| 160 | |
| 161 pygame.examples.scaletest.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
162 scaletest.main(imagefile, convert_alpha=False, run_speed_test=True) -> None |
| 1937 | 163 interactively scale an image using smoothscale |
| 164 | |
| 165 pygame.examples.midi.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
166 midi.main(mode='output', device_id=None) -> None |
| 1937 | 167 run a midi example |
| 168 | |
| 169 pygame.examples.scroll.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
170 scroll.main(image_file=None) -> None |
| 1937 | 171 run a Surface.scroll example that shows a magnified image |
| 172 | |
| 173 pygame.examples.movieplayer.main | |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
174 movieplayer.main(filepath) -> None |
| 1937 | 175 play an MPEG movie |
| 176 | |
|
2147
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
177 pygame.examples.camera.main |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
178 camera.main() -> None |
|
2147
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
179 display video captured live from an attached camera |
|
6823896ce90d
some minor updates and fixes to the docs
Lenard Lindstrom <len-l@telus.net>
parents:
1937
diff
changeset
|
180 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2166
diff
changeset
|
181 */ |
