Mercurial > pygame

annotate docs/ref/pygame_cursor.html @ 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 57c120cd3a49
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
680
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
1 <html>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
2 <title>pygame.cursor</title>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
3 <body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
4
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
5
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
6 <table cellspacing=3 width=100%><tr><td bgcolor=#00000>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
7 <table width=100%><tr><td bgcolor=c2fc20 align=center>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
8 <a href=http://www.pygame.org>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
9 <img src=../pygame_tiny.gif border=0 width=200 height=60></a><br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
10 <b>pygame&nbsp;&nbsp;&nbsp;documentation</b>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
11 </td><td bgcolor=6aee28 align=center valign=top width=100%>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
12
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
13 ||&nbsp;
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
14 <a href=http://www.pygame.org>Home</a> &nbsp;||&nbsp;
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
15 <a href=../index.html>Help Contents</a> &nbsp;||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
16 <br>&nbsp;<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
17
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
18 || <a href=pygame.html>pygame</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
19 <a href=pygame_cdrom.html>cdrom</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
20 <a href=pygame_constants.html>constants</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
21 <a href=pygame_cursor.html>cursor</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
22 <a href=pygame_display.html>display</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
23 <a href=pygame_draw.html>draw</a> ||<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
24 || <a href=pygame_event.html>event</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
25 <a href=pygame_font.html>font</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
26 <a href=pygame_image.html>image</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
27 <a href=pygame_joystick.html>joystick</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
28 <a href=pygame_key.html>key</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
29 <a href=pygame_mixer.html>mixer</a> ||<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
30 || <a href=pygame_mixer_music.html>mixer_music</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
31 <a href=pygame_mouse.html>mouse</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
32 <a href=pygame_movie.html>movie</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
33 <a href=pygame_sndarray.html>sndarray</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
34 <a href=pygame_surfarray.html>surfarray</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
35 <a href=pygame_time.html>time</a> ||<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
36 || <a href=pygame_transform.html>transform</a> ||<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
37 &nbsp;<br>|| <a href=CD.html>CD</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
38 <a href=Channel.html>Channel</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
39 <a href=Clock.html>Clock</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
40 <a href=Font.html>Font</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
41 <a href=Joystick.html>Joystick</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
42 <a href=Movie.html>Movie</a> ||<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
43 || <a href=Overlay.html>Overlay</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
44 <a href=Rect.html>Rect</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
45 <a href=Sound.html>Sound</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
46 <a href=Surface.html>Surface</a> ||<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
47 &nbsp;<br>|| <a href=pygame_color.html>color</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
48 <a href=pygame_cursors.html>cursors</a> ||
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
49 <a href=pygame_sprite.html>sprite</a> ||<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
50
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
51
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
52 </td></tr></table></td></tr></table>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
53 <br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
54 <h2 align=center>pygame.cursor</h2>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
55 {module}
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
56
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
57 <hr>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
58
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
59 <table>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
60 <tr><td><a href=#compile>compile</a></td><td> -
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
61 compile cursor strings into cursor data</td></tr>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
62
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
63
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
64 </table>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
65
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
66 <hr>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
67
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
68 <a name=compile><font size=+2><b>compile
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
69 </b></font><br><font size=+1><tt>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
70 pygame.cursor.compile(strings, black, white,xor) -> data, mask
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
71 </tt></font><ul>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
72 This takes a set of strings with equal length and computes
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
73 the binary data for that cursor. The string widths must be
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
74 divisible by 8.
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
75 <br>&nbsp;<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
76 The black and white arguments are single letter strings that
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
77 tells which characters will represent black pixels, and which
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
78 characters represent white pixels. All other characters are
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
79 considered clear.
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
80 <br>&nbsp;<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
81 This returns a tuple containing the cursor data and cursor mask
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
82 data. Both these arguments are used when setting a cursor with
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
83 <a href=pygame_mouse.html#set_cursor>pygame.mouse.set_cursor()</a>.
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
84 <br>&nbsp;<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
85 </ul><br>&nbsp;<br>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
86
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
87
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
88 <hr>
57c120cd3a49 Some documentation new scrap module. ... and some missing docs for cursor.
Rene Dudfield <renesd@gmail.com>
parents:
diff changeset
89 </body></html>