pygame: lib/examples.doc annotate

annotate lib/examples.doc @ 1849:301bc61643a9 math_module

merged changes from trunk

author	lorenz
date	Mon, 16 Nov 2009 18:31:40 +0000
parents	edac9c651c4c
children	2d7ce556083b

rev	line source
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	1 pygame.examples
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	2 module of example programs
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	3
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	4 These examples should help get you started with pygame. Here is a
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	5 brief rundown of what you get. The source code for these examples
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	6 is in the public domain. Feel free to use for your own projects.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	7
1617 324c19f22af0 Add pygame.examples.go shortcut Lenard Lindstrom <len-l@telus.net> parents: 1528 diff changeset	8 There are several ways to run the examples. First they can be run
324c19f22af0 Add pygame.examples.go shortcut Lenard Lindstrom <len-l@telus.net> parents: 1528 diff changeset	9 as stand-alone programs. Second they can be imported and their
1619 edac9c651c4c some doc updates for test tags and python -m option Lenard Lindstrom <len-l@telus.net> parents: 1618 diff changeset	10 main() methods called (see below). Finally, the easiest way is
edac9c651c4c some doc updates for test tags and python -m option Lenard Lindstrom <len-l@telus.net> parents: 1618 diff changeset	11 to use the python -m option:
1617 324c19f22af0 Add pygame.examples.go shortcut Lenard Lindstrom <len-l@telus.net> parents: 1528 diff changeset	12
1619 edac9c651c4c some doc updates for test tags and python -m option Lenard Lindstrom <len-l@telus.net> parents: 1618 diff changeset	13 python -m pygame.examples.<example name> <example arguments>
1617 324c19f22af0 Add pygame.examples.go shortcut Lenard Lindstrom <len-l@telus.net> parents: 1528 diff changeset	14
1619 edac9c651c4c some doc updates for test tags and python -m option Lenard Lindstrom <len-l@telus.net> parents: 1618 diff changeset	15 eg:
1617 324c19f22af0 Add pygame.examples.go shortcut Lenard Lindstrom <len-l@telus.net> parents: 1528 diff changeset	16
1619 edac9c651c4c some doc updates for test tags and python -m option Lenard Lindstrom <len-l@telus.net> parents: 1618 diff changeset	17 python -m pygame.examples.scaletest someimage.png
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	18
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	19 Resources for the examples are found in the pygame/examples/data
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	20 subdirectory.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	21
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	22 We're always on the lookout for more examples and/or example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	23 requests. Code like this is probably the best way to start
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	24 getting involved with python gaming.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	25
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	26 This page is adapted from the original examples readme.txt by:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	27 Pete Shinners
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	28 shredwheat@mediaone.net
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	29
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	30 Further references
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	31
1450 33113f865b25 make some hyperlinks in the examples doc work Lenard Lindstrom <len-l@telus.net> parents: 1448 diff changeset	32 pySDL : <a href="http://pysdl.sourceforge.net">http://pysdl.sourceforge.net<a/>
33113f865b25 make some hyperlinks in the examples doc work Lenard Lindstrom <len-l@telus.net> parents: 1448 diff changeset	33 SDL : <a href="http://www.libsdl.org">http://www.libsdl.org<a/>
33113f865b25 make some hyperlinks in the examples doc work Lenard Lindstrom <len-l@telus.net> parents: 1448 diff changeset	34 aliens.c : <a href="http://www.libsdl.org/projects/aliens">http://www.libsdl.org/projects/aliens<a/>
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	35
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	36 examples as a package is new to pygame 1.9.0.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	37 <SECTION>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	38
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	39
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	40
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	41 aliens.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	42 play the full aliens example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	43 pygame.aliens.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	44
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	45 This started off as a port of the SDL demonstration,
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	46 Aliens. Now it has evolved into something sort of resembling
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	47 fun. This demonstrates a lot of different uses of sprites and
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	48 optimized blitting. Also transparency, colorkeys, fonts, sound,
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	49 music, joystick, and more. (PS, my high score is 117! goodluck)
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	50 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	51
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	52
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	53
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	54 oldalien.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	55 play the original aliens example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	56 pygame.examples.oldalien.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	57
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	58 This more closely resembles a port of the SDL Aliens
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	59 demo. The code is a lot simpler, so it makes a better starting
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	60 point for people looking at code for the first times. These
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	61 blitting routines are not as optimized as they should/could be,
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	62 but the code is easier to follow, and it plays quick enough.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	63 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	64
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	65
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	66
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	67 stars.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	68 run a simple starfield example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	69 pygame.examples.stars.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	70
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	71 A simple starfield example. You can change the center of
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	72 perspective by leftclicking the mouse on the screen.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	73 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	74
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	75
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	76
1492 430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	77 chimp.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	78 hit the moving chimp
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	79 pygame.examples.chimp.main(): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	80
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	81 This simple example is derived from the line-by-line tutorial
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	82 that comes with pygame. It is based on a 'popular' web banner.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	83 Note there are comments here, but for the full explanation,
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	84 follow along in the tutorial.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	85 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	86
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	87
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	88
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	89
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	90 moveit.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	91 display animated objects on the screen
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	92 pygame.examples.moveit.main(): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	93
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	94 This is the full and final example from the Pygame Tutorial,
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	95 "How Do I Make It Move". It creates 10 objects and animates
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	96 them on the screen.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	97
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	98 Note it's a bit scant on error checking, but it's easy to read. :]
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	99 Fortunately, this is python, and we needn't wrestle with a pile of
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	100 error codes.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	101 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	102
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	103
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	104
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	105
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	106 fonty.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	107 run a font rendering example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	108 pygame.examples.fonty.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	109
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	110 Super quick, super simple application demonstrating
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	111 the different ways to render fonts with the font module
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	112 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	113
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	114
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	115
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	116 vgrade.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	117 display a vertical gradient
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	118 pygame.examples.vgrade.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	119
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	120 Demonstrates creating a vertical gradient with
1528 05354a46bd12 Fixed some typos. Rene Dudfield <renesd@gmail.com> parents: 1525 diff changeset	121 NumPy python. The app will create a new gradient every half
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	122 second and report the time needed to create and display the
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	123 image. If you're not prepared to start working with the
1528 05354a46bd12 Fixed some typos. Rene Dudfield <renesd@gmail.com> parents: 1525 diff changeset	124 NumPy arrays, don't worry about the source for this one :]
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	125 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	126
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	127
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	128
1492 430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	129 eventlist.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	130 display pygame events
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	131 pygame.examples.eventlist.main(): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	132
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	133 Eventlist is a sloppy style of pygame, but is a handy
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	134 tool for learning about pygame events and input. At the
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	135 top of the screen are the state of several device values,
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	136 and a scrolling list of events are displayed on the bottom.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	137
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	138 This is not quality 'ui' code at all, but you can see how
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	139 to implement very non-interactive status displays, or even
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	140 a crude text output control.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	141 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	142
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	143
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	144
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	145
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	146 arraydemo.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	147 show various surfarray effects
1451 d480367ed509 fix NumPy bug in arraydemo.py and add an array choice command line arguemnt Lenard Lindstrom <len-l@telus.net> parents: 1450 diff changeset	148 pygame.examples.arraydemo.main(arraytype=None): return None
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	149
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	150 Another example filled with various surfarray
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	151 effects. It requires the surfarray and image modules to
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	152 be installed. This little demo can also make a good starting
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	153 point for any of your own tests with surfarray
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	154
1451 d480367ed509 fix NumPy bug in arraydemo.py and add an array choice command line arguemnt Lenard Lindstrom <len-l@telus.net> parents: 1450 diff changeset	155 If arraytype is provided then use that array package. Valid
d480367ed509 fix NumPy bug in arraydemo.py and add an array choice command line arguemnt Lenard Lindstrom <len-l@telus.net> parents: 1450 diff changeset	156 values are 'numeric' or 'numpy'. Otherwise default to NumPy,
d480367ed509 fix NumPy bug in arraydemo.py and add an array choice command line arguemnt Lenard Lindstrom <len-l@telus.net> parents: 1450 diff changeset	157 or fall back on Numeric if NumPy is not installed. As a program
d480367ed509 fix NumPy bug in arraydemo.py and add an array choice command line arguemnt Lenard Lindstrom <len-l@telus.net> parents: 1450 diff changeset	158 surfarray.py accepts an optional --numeric or --numpy flag. (New pygame 1.9.0)
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	159 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	160
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	161
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	162
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	163 sound.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	164 load and play a sound
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	165 pygame.examples.sound.main(file_path=None): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	166
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	167 Extremely basic testing of the mixer module. Load a
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	168 sound and play it. All from the command shell, no graphics.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	169
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	170 If provided, use the audio file 'file_path', otherwise use a
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	171 default file.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	172
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	173 sound.py optional command line argument: an audio file
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	174 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	175
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	176
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	177
1492 430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	178 sound_array_demos.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	179 play various sndarray effects
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	180 pygame.examples.sound_array_demos.main(arraytype=None): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	181
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	182 If arraytype is provided then use that array package. Valid
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	183 values are 'numeric' or 'numpy'. Otherwise default to NumPy,
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	184 or fall back on Numeric if NumPy is not installed.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	185
1528 05354a46bd12 Fixed some typos. Rene Dudfield <renesd@gmail.com> parents: 1525 diff changeset	186 Uses sndarray and NumPy ( or Numeric) to create offset faded copies of the
1492 430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	187 original sound. Currently it just uses hardcoded values for the
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	188 number of echos and the delay. Easy for you to recreate as
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	189 needed. Run as a program sound_array_demos.py takes an optional
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	190 command line option, --numpy or --numeric, specifying which array package
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	191 to use.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	192 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	193
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	194
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	195
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	196 liquid.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	197 display an animated liquid effect
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	198 pygame.examples.liquid.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	199
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	200 This example was created in a quick comparison with the
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	201 BlitzBasic gaming language. Nonetheless, it demonstrates a quick
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	202 8-bit setup (with colormap).
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	203 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	204
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	205
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	206
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	207 glcube.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	208 display an animated 3D cube using OpenGL
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	209 pygame.examples.glcube.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	210
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	211 Using PyOpenGL and pygame, this creates a spinning 3D
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	212 multicolored cube.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	213 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	214
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	215
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	216
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	217 scrap_clipboard.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	218 access the clipboard
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	219 pygame.examples.scrap_clipboard.main(): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	220
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	221 A simple demonstration example for the clipboard support.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	222 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	223
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	224
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	225
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	226
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	227 mask.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	228 display multiple images bounce off each other using collision detection
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	229 pygame.examples.mask.main(*args): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	230
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	231 Positional arguments:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	232 one or more image file names.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	233
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	234 This pygame.masks demo will display multiple moving sprites bouncing
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	235 off each other. More than one sprite image can be provided.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	236
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	237 If run as a program then mask.py takes one or more image files
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	238 as command line arguments.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	239 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	240
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	241
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	242
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	243
1492 430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	244 testsprite.main
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	245 show lots of sprites moving around
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	246 pygame.examples.testsprite.main(update_rects = True, use_static = False, use_FastRenderGroup = False, screen_dims = [640, 480], use_alpha = False, flags = 0): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	247
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	248 Optional keyword arguments:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	249 update_rects - use the RenderUpdate sprite group class
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	250 use_static - include non-moving images
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	251 use_FastRenderGroup - Use the FastRenderGroup sprite group
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	252 screen_dims - pygame window dimensions
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	253 use_alpha - use alpha blending
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	254 flags - additional display mode flags
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	255
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	256 Like the testsprite.c that comes with sdl, this pygame version shows
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	257 lots of sprites moving around.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	258
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	259 If run as a stand-alone program then no command line arguments are taken.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	260 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	261
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	262
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	263
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	264
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	265 headless_no_windows_needed.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	266 write an image file that is smoothscaled copy of an input file
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	267 pygame.examples.headless_no_windows_needed.main(fin, fout, w, h): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	268
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	269 arguments:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	270 fin - name of an input image file
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	271 fout - name of the output file to create/overwrite
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	272 w, h - size of the rescaled image, as integer width and height
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	273
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	274 How to use pygame with no windowing system, like on headless servers.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	275
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	276 Thumbnail generation with scaling is an example of what you can do with pygame.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	277
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	278 NOTE: the pygame scale function uses mmx/sse if available, and can be run
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	279 in multiple threads.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	280
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	281 If headless_no_windows_needed.py is run as a program it takes the following
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	282 command line arguments:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	283 -scale inputimage outputimage new_width new_height
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	284 eg. -scale in.png outpng 50 50
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	285 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	286
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	287
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	288
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	289
1492 430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	290 fastevents.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	291 stress test the fastevents module
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	292 pygame.examples.fastevents.main(): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	293
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	294 This is a stress test for the fastevents module.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	295
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	296 Fast events does not appear faster!
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	297
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	298 So far it looks like normal pygame.event is faster by up to two times.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	299 So maybe fastevent isn't fast at all.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	300
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	301 Tested on windowsXP sp2 athlon, and freebsd.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	302
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	303 However... on my debian duron 850 machine fastevents is faster.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	304 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	305
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	306
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	307
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	308
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	309 overlay.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	310 play a .pgm video using overlays
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	311 pygame.examples.overlay.main(fname): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	312
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	313 Play the .pgm video fila a path fname.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	314
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	315 If run as a program overlay.py takes the file name as a command line argument.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	316 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	317
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	318
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	319
1492 430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	320 blend_fill.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	321 demonstrate the various surface.fill method blend options
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	322 pygame.examples.blend_fill.main(): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	323
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	324 A interactive demo that lets one choose which BLEND_xxx option to apply to a surface.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	325 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	326
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	327
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	328 cursors.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	329 display two different custom cursors
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	330 pygame.examples.cursors.main(): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	331
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	332 Display an arrow or circle with crossbar cursor.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	333 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	334
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	335
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	336
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	337 pixelarray.main
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	338 display various pixelarray generated effects
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	339 pygame.examples.pixelarray.main(): return None
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	340
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	341 Display various pixelarray generated effects.
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	342 <END>
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	343
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	344
430243520809 some examples cleanup Lenard Lindstrom <len-l@telus.net> parents: 1451 diff changeset	345
1448 c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	346
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	347 scaletest.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	348 interactively scale an image using smoothscale
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	349 pygame.examples.scaletest.main(imagefile, convert_alpha=False, run_speed_test=True): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	350
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	351 arguments:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	352 imagefile - file name of source image (required)
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	353 convert_alpha - use convert_alpha() on the surf (default False)
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	354 run_speed_test - (default False)
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	355
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	356 A smoothscale example that resized an image on the screen.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	357 Vertical and horizontal arrow keys are used to change the width and
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	358 height of the displayed image. If the convert_alpha option is True
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	359 then the source image is forced to have source alpha, whether or
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	360 not the original images does. If run_speed_test is True then a
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	361 background timing test is performed instead of the interactive scaler.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	362
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	363 If scaletest.py is run as a program then the command line options are:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	364 ImageFile [-t] [-convert_alpha]
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	365 [-t] = Run Speed Test
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	366 [-convert_alpha] = Use convert_alpha() on the surf.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	367 <END>
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	368
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	369
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	370
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	371 midi.main
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	372 run a midi example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	373 pygame.examples.midi.main(mode='output', device_id=None): return None
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	374
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	375 Arguments:
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	376 mode - if 'output' run a midi keyboard output example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	377 'input' run a midi event logger input example
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	378 'list' list available midi devices
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	379 (default 'output')
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	380 device_id - midi device number; if None then use the default midi input or
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	381 output device for the system
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	382
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	383 The output example shows how to translate mouse clicks or computer keyboard
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	384 events into midi notes. It implements a rudimentary button widget and state
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	385 machine.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	386
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	387 The input example shows how to translate midi input to pygame events.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	388
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	389 With the use of a virtual midi patch cord the output and input examples can
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	390 be run as separate processes and connected so the keyboard output is displayed
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	391 on a console.
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	392
c496066bc336 add examples module document page Lenard Lindstrom <len-l@telus.net> parents: diff changeset	393 new to pygame 1.9.0
1525 48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	394 <END>
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	395
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	396
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	397
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	398 scroll.main
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	399 run a Surface.scroll example that shows a magnified image
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	400 pygame.examples.scroll.main(image_file=None): return None
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	401
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	402 This example shows a scrollable image that has a zoom factor of eight.
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	403 It uses the Surface.scroll function to shift the image on the display
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	404 surface. A clip rectangle protects a margin area. If called as a function,
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	405 the example accepts an optional image file path. If run as a program
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	406 it takes an optional file path command line argument. If no file
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	407 is provided a default image file is used.
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	408
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	409 When running click on a black triangle to move one pixel in the direction
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	410 the triangle points. Or use the arrow keys. Close the window or press ESC
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	411 to quit.
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	412 <END>
48ab3db38416 add Surface.scroll method Lenard Lindstrom <len-l@telus.net> parents: 1492 diff changeset	413
1618 154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	414
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	415
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	416 movieplayer.main
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	417 play an MPEG movie
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	418 pygame.examples.moveplayer.main(filepath): return None
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	419
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	420 A simple movie player that plays an MPEG movie in a Pygame window. It showcases
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	421 the pygame.movie module. The window adjusts to the size of the movie image. It
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	422 is given a boarder to demonstrate that a movie can play autonomously in a sub-
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	423 window. Also, the file is copied to a file like object to show that not just
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	424 Python files can be used as a movie source.
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	425
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	426 The pygame.movie module is problematic and may not work on all systems. It is
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	427 intended to replace it with an ffmpeg based version.
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	428 <END>
154b030df6e5 add movieplayer example to the documents Lenard Lindstrom <len-l@telus.net> parents: 1617 diff changeset	429 <END>

Mercurial > pygame

annotate lib/examples.doc @ 1849:301bc61643a9 math_module