Commits

Anonymous committed 6aad3b4

small cleanups (doc/music)

  • Participants
  • Parent commits 750d784

Comments (0)

Files changed (2)

docs/ref/pygame_cursors.html

 
 <a name=compile><font size=+2><b>compile
 </b></font><br><font size=+1><tt>
-pygame.cursors.compile(strings, black, white) -> data
+pygame.cursors.compile(strings, black, white) -> data, mask
 </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
 characters represent white pixels. All other characters are
 considered clear.
 <br>&nbsp;<br>
+This returns a tuple containing the cursor data and cursor mask
+data. Both these arguments are used when setting a cursor with
+pygame.mouse.set_cursor().
+<br>&nbsp;<br>
 </ul><br>&nbsp;<br>
 
 <a name=load_xbm><font size=+2><b>load_xbm
 
 
 def compile(strings, black, white):
-    """pygame.cursors.compile(strings, black, white) -> data
+    """pygame.cursors.compile(strings, black, white) -> data, mask
 compile cursor strings into cursor data
 
 This takes a set of strings with equal length and computes
 tells which characters will represent black pixels, and which
 characters represent white pixels. All other characters are
 considered clear.
+
+This returns a tuple containing the cursor data and cursor mask
+data. Both these arguments are used when setting a cursor with
+pygame.mouse.set_cursor().
 """
     
     #first check for consistent lengths