Commits

Anonymous committed c2894d5

docs now do python modules too

  • Participants
  • Parent commits 9327ae2

Comments (0)

Files changed (3)

docs/ref/pygame_UserRect.html

+<html>
+<title>pygame.UserRect</title>
+<body bgcolor=#dddddd text=#333377 link=#7777bb vlink=#7777bb>
+
+<table border=0 width=100% cellpadding=0 cellspacing=0 bgcolor=#f5f5f5><tr valign=top>
+<td rowspan=2><table border=0 cellpadding=5 cellspacing=0 bgcolor=#333377>
+<tr height=86 align=left><td valign=middle><font color=#ffffff size=+5>
+	<a href=../index.html><font size=+5 color=#ffffff><i><b>
+      pygame</b></i></font></a>&nbsp;&nbsp;</td>
+<td valign=middle><tt><font color=#dddddd><br>
+	pygame<br>documentation</font>
+</td></tr></table></td><td width=100% align=center valign=middle>
+
+	||&nbsp;
+	<a href=http://pygame.seul.org>Home</a> &nbsp;||&nbsp;
+	<a href=../index.html>Help Contents</a> &nbsp;||
+	<br>&nbsp;<br>
+
+|| <a href=CD.html>CD</a> || 
+<a href=Channel.html>Channel</a> || 
+<a href=Font.html>Font</a> || 
+<a href=Joystick.html>Joystick</a> || 
+<a href=Rect.html>Rect</a> || 
+<a href=Sound.html>Sound</a> || 
+<a href=Surface.html>Surface</a> ||<br>
+|| <a href=pygame.html>pygame</a> || 
+<a href=pygame_UserRect.html>UserRect</a> || 
+<a href=pygame_cdrom.html>cdrom</a> || 
+<a href=pygame_constants.html>constants</a> || 
+<a href=pygame_cursors.html>cursors</a> || 
+<a href=pygame_display.html>display</a> || 
+<a href=pygame_event.html>event</a> ||<br>
+|| <a href=pygame_font.html>font</a> || 
+<a href=pygame_image.html>image</a> || 
+<a href=pygame_joystick.html>joystick</a> || 
+<a href=pygame_key.html>key</a> || 
+<a href=pygame_mixer.html>mixer</a> || 
+<a href=pygame_mixer_music.html>mixer_music</a> || 
+<a href=pygame_mouse.html>mouse</a> ||<br>
+|| <a href=pygame_surfarray.html>surfarray</a> || 
+<a href=pygame_time.html>time</a> || 
+<a href=pygame_version.html>version</a> ||<br>
+
+
+</td></tr></table>
+<br>
+<h2 align=center>pygame.UserRect</h2>
+UserRect, python class wrapped around the pygame Rect type. This allows
+you to do things like inherit the rectangle object into a sprite class. While
+this makes for some neat features, current testing has shown there is a bit of
+a peformance penalty. (as opposed to just keeping a Rect value inside the class)
+<br>&nbsp;<br>
+
+<hr>
+
+<table>
+<tr><td><a href=#UserRect>UserRect</a></td><td> -
+Python class for the pygame Rect type</td></tr>
+
+
+</table>
+
+<hr>
+
+<a name=UserRect><font size=+2><b>UserRect
+</b></font><br><font size=+1><tt>
+pygame.UserRect.UserRect() -> class instance
+</tt></font><ul>
+This python class can be treated exactly like a normal Rect
+object. The only difference is it is a real python class
+object, not a C extension type.
+<br>&nbsp;<br>
+</ul><br>&nbsp;<br>
+
+
+<hr>
+
+</body></html>

docs/ref/pygame_cursors.html

+<html>
+<title>pygame.cursors</title>
+<body bgcolor=#dddddd text=#333377 link=#7777bb vlink=#7777bb>
+
+<table border=0 width=100% cellpadding=0 cellspacing=0 bgcolor=#f5f5f5><tr valign=top>
+<td rowspan=2><table border=0 cellpadding=5 cellspacing=0 bgcolor=#333377>
+<tr height=86 align=left><td valign=middle><font color=#ffffff size=+5>
+	<a href=../index.html><font size=+5 color=#ffffff><i><b>
+      pygame</b></i></font></a>&nbsp;&nbsp;</td>
+<td valign=middle><tt><font color=#dddddd><br>
+	pygame<br>documentation</font>
+</td></tr></table></td><td width=100% align=center valign=middle>
+
+	||&nbsp;
+	<a href=http://pygame.seul.org>Home</a> &nbsp;||&nbsp;
+	<a href=../index.html>Help Contents</a> &nbsp;||
+	<br>&nbsp;<br>
+
+|| <a href=CD.html>CD</a> || 
+<a href=Channel.html>Channel</a> || 
+<a href=Font.html>Font</a> || 
+<a href=Joystick.html>Joystick</a> || 
+<a href=Rect.html>Rect</a> || 
+<a href=Sound.html>Sound</a> || 
+<a href=Surface.html>Surface</a> ||<br>
+|| <a href=pygame.html>pygame</a> || 
+<a href=pygame_UserRect.html>UserRect</a> || 
+<a href=pygame_cdrom.html>cdrom</a> || 
+<a href=pygame_constants.html>constants</a> || 
+<a href=pygame_cursors.html>cursors</a> || 
+<a href=pygame_display.html>display</a> || 
+<a href=pygame_event.html>event</a> ||<br>
+|| <a href=pygame_font.html>font</a> || 
+<a href=pygame_image.html>image</a> || 
+<a href=pygame_joystick.html>joystick</a> || 
+<a href=pygame_key.html>key</a> || 
+<a href=pygame_mixer.html>mixer</a> || 
+<a href=pygame_mixer_music.html>mixer_music</a> || 
+<a href=pygame_mouse.html>mouse</a> ||<br>
+|| <a href=pygame_surfarray.html>surfarray</a> || 
+<a href=pygame_time.html>time</a> || 
+<a href=pygame_version.html>version</a> ||<br>
+
+
+</td></tr></table>
+<br>
+<h2 align=center>pygame.cursors</h2>
+Set of cursor resources available for use. These cursors come
+in a sequence of values that are needed as the arguments for
+pygame.mouse.set_cursor(). to dereference the sequence in place
+and create the cursor in one step, call like this;
+pygame.mouse.set_cursor(*pygame.cursors.arrow).
+<br>&nbsp;<br>
+Here is a list of available cursors; arrow, diamond, ball,
+        broken_x, tri_left, tri_right
+<br>&nbsp;<br>
+There is also a sample string cursor named 'thickarrow_strings'.
+The compile() function can convert these string cursors into cursor byte data.
+<br>&nbsp;<br>
+
+<hr>
+
+<table>
+<tr><td><a href=#compile>compile</a></td><td> -
+compile cursor strings into cursor data</td></tr>
+
+
+<tr><td><a href=#read_xbm>read_xbm</a></td><td> -
+reads a pair of XBM files into set_cursor arguments</td></tr>
+
+
+</table>
+
+<hr>
+
+<a name=compile><font size=+2><b>compile
+</b></font><br><font size=+1><tt>
+pygame.cursors.compile(strings, black, white) -> data
+</tt></font><ul>
+This takes a set of strings with equal length and computes
+the binary data for that cursor. The string widths must be
+divisible by 6. The data returned are suitable for passing
+to <a href=pygame_mouse.html#set_cursor>pygame.mouse.set_cursor()</a>
+<br>&nbsp;<br>
+</ul><br>&nbsp;<br>
+
+<a name=read_xbm><font size=+2><b>read_xbm
+</b></font><br><font size=+1><tt>
+pygame.cursors.read_xbm(cursorfile, maskfile) -> cursor_args
+</tt></font><ul>
+Arguments can either be strings or filelike objects
+with the readlines method. Not largely tested, but
+should work with typical XBM files.
+<br>&nbsp;<br>
+</ul><br>&nbsp;<br>
+
+
+<hr>
+
+</body></html>

docs/ref/pygame_version.html

+<html>
+<title>pygame.version</title>
+<body bgcolor=#dddddd text=#333377 link=#7777bb vlink=#7777bb>
+
+<table border=0 width=100% cellpadding=0 cellspacing=0 bgcolor=#f5f5f5><tr valign=top>
+<td rowspan=2><table border=0 cellpadding=5 cellspacing=0 bgcolor=#333377>
+<tr height=86 align=left><td valign=middle><font color=#ffffff size=+5>
+	<a href=../index.html><font size=+5 color=#ffffff><i><b>
+      pygame</b></i></font></a>&nbsp;&nbsp;</td>
+<td valign=middle><tt><font color=#dddddd><br>
+	pygame<br>documentation</font>
+</td></tr></table></td><td width=100% align=center valign=middle>
+
+	||&nbsp;
+	<a href=http://pygame.seul.org>Home</a> &nbsp;||&nbsp;
+	<a href=../index.html>Help Contents</a> &nbsp;||
+	<br>&nbsp;<br>
+
+|| <a href=CD.html>CD</a> || 
+<a href=Channel.html>Channel</a> || 
+<a href=Font.html>Font</a> || 
+<a href=Joystick.html>Joystick</a> || 
+<a href=Rect.html>Rect</a> || 
+<a href=Sound.html>Sound</a> || 
+<a href=Surface.html>Surface</a> ||<br>
+|| <a href=pygame.html>pygame</a> || 
+<a href=pygame_UserRect.html>UserRect</a> || 
+<a href=pygame_cdrom.html>cdrom</a> || 
+<a href=pygame_constants.html>constants</a> || 
+<a href=pygame_cursors.html>cursors</a> || 
+<a href=pygame_display.html>display</a> || 
+<a href=pygame_event.html>event</a> ||<br>
+|| <a href=pygame_font.html>font</a> || 
+<a href=pygame_image.html>image</a> || 
+<a href=pygame_joystick.html>joystick</a> || 
+<a href=pygame_key.html>key</a> || 
+<a href=pygame_mixer.html>mixer</a> || 
+<a href=pygame_mixer_music.html>mixer_music</a> || 
+<a href=pygame_mouse.html>mouse</a> ||<br>
+|| <a href=pygame_surfarray.html>surfarray</a> || 
+<a href=pygame_time.html>time</a> || 
+<a href=pygame_version.html>version</a> ||<br>
+
+
+</td></tr></table>
+<br>
+<h2 align=center>pygame.version</h2>
+Simply the current installed pygame version. The version information is
+stored in the regular pygame module as 'pygame.ver'. Keeping the version
+information also available in a separate module allows you to test the
+pygame version without importing the main pygame module.
+<br>&nbsp;<br>
+The python version information should always compare greater than any previous
+releases. (hmm, until we get to versions > 10)
+<br>&nbsp;<br>
+
+<hr>
+
+<table>
+<tr><td><a href=#ver>ver</a></td><td> -
+The current pygame version info</td></tr>
+
+
+</table>
+
+<hr>
+
+<a name=ver><font size=+2><b>ver
+</b></font><br><font size=+1><tt>
+pygame.version.ver 
+</tt></font><ul>
+The ver variable is simply a string containing the version information
+for pygame. An example is "0.5" or "1.0"
+<br>&nbsp;<br>
+</ul><br>&nbsp;<br>
+
+
+<hr>
+
+</body></html>