Commits

Thomas Kluyver  committed 1d9aaaa

Forget more Sphinx-generated files

  • Participants
  • Parent commits 46f3339
  • Branches docs-changes

Comments (0)

Files changed (38)

File docs/filepaths.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>File Path Function Arguments &mdash; Pygame v1.9.2 documentation</title>
-    <link rel="stylesheet" href="_static/pygame.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '',
-        VERSION:     '1.9.2',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="_static/jquery.js"></script>
-    <script type="text/javascript" src="_static/underscore.js"></script>
-    <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="shortcut icon" href="_static/pygame.ico"/>
-    <link rel="top" title="Pygame v1.9.2 documentation" href="index.html" />
-    <link rel="prev" title="pygame.transform" href="ref/transform.html" /> 
-  </head>
-  <body>  
-
-    <div class="document">
-
-  <div class="header">
-    <table>
-      <tr>
-	<td class="logo">
-	  <a href="http://www.pygame.org/">
-	    <img src="_static/pygame_tiny.png"/>
-	  </a>
-	  <h5>pygame documentation</h5>
-	</td>
-	<td class="pagelinks">
-	  <p class="top">
-	    ||
-	    <a href="http://www.pygame.org/">Pygame Home</a> ||
-	    <a href="index.html">Help Contents</a> ||
-	    <a href="genindex.html">Reference Index</a> ||
-	  </p>
-	  <p class="bottom">
-	    <a href="ref/camera.html">camera</a> || 
-	    <a href="ref/cdrom.html">cdrom</a> || 
-	    <a href="ref/color.html">Color</a> || 
-	    <a href="ref/cursors.html">cursors</a> || 
-	    <a href="ref/display.html">display</a> || 
-	    <a href="ref/draw.html">draw</a> || 
-	    <a href="ref/event.html">event</a> || 
-	    <a href="ref/examples.html">examples</a> || 
-	    <a href="ref/font.html">font</a> || 
-	    <a href="ref/freetype.html">freetype</a> || 
-	    <a href="ref/gfxdraw.html">gfxdraw</a> || 
-	    <a href="ref/image.html">image</a> || 
-	    <a href="ref/joystick.html">joystick</a> || 
-	    <a href="ref/key.html">key</a> || 
-	    <a href="ref/locals.html">locals</a> || 
-	    <a href="ref/mask.html">mask</a> || 
-	    <a href="ref/math.html">math</a> || 
-	    <a href="ref/midi.html">midi</a> || 
-	    <a href="ref/mixer.html">mixer</a> || 
-	    <a href="ref/mouse.html">mouse</a> || 
-	    <a href="ref/movie.html">movie</a> || 
-	    <a href="ref/music.html">music</a> || 
-	    <a href="ref/overlay.html">Overlay</a> || 
-	    <a href="ref/pixelarray.html">PixelArray</a> || 
-	    <a href="ref/pixelcopy.html">pixelcopy</a> || 
-	    <a href="ref/pygame.html">pygame</a> || 
-	    <a href="ref/rect.html">Rect</a> || 
-	    <a href="ref/scrap.html">scrap</a> || 
-	    <a href="ref/sndarray.html">sndarray</a> || 
-	    <a href="ref/sprite.html">sprite</a> || 
-	    <a href="ref/surface.html">Surface</a> || 
-	    <a href="ref/surfarray.html">surfarray</a> || 
-	    <a href="ref/tests.html">tests</a> || 
-	    <a href="ref/time.html">time</a> || 
-	    <a href="ref/transform.html">transform</a> || 
-	    <a href="ref/pygame.html#module-pygame.version">version</a>
-	  </p>
-	</td>
-      </tr>
-    </table>
-  </div>
-
-      <div class="documentwrapper">
-          <div class="body">
-            
-  <div class="sectionwrapper">
-<div class="section" id="file-path-function-arguments">
-<div class="section" id="id1">
-<h2>File Path Function Arguments<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
-<blockquote>
-<p>A Pygame function or method which takes a file path argument
-will accept either an Unicode or a byte — 8-bit or ASCII character — string.
-Unicode strings are translated to Python&#8217;s default file system encoding,
-as returned by sys.getfilesystemencoding().
-An Unicode code point above U+FFFF — &#8217;uFFFF&#8217; — can
-be coded directly with a 32-bit escape
-sequences — &#8217;Uxxxxxxxx&#8217; — ,
-even for Python interpreters built with an UCS-2 (16-bit character) unicode type.
-Byte strings are passed to the operating system unchanged.</p>
-<p>Null characters — &#8217;x00&#8217; —
-are not permitted in the path, raising an exception.
-An exception is also raised if an Unicode file path cannot be encoded.
-How UTF-16 surrogate codes are handled is Python interpreter dependent.
-Use UTF-32 code points and 32-bit escape sequences instead.
-The exception types are function dependent.</p>
-</blockquote>
-</div>
-</div>
-
-  </div>
-          </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related">
-      <h3>Navigation</h3>
-      <ul>
-        <li class="right" style="margin-right: 10px">
-          <a href="genindex.html" title="General Index"
-             accesskey="I">index</a></li>
-        <li class="right" >
-          <a href="ref/transform.html" title="pygame.transform"
-             accesskey="P">previous</a> |</li>
-        <li><a href="index.html">Pygame v1.9.2 documentation</a> &raquo;</li>
-    <script type="text/javascript" src="jquery.plugin.docscomments.js"></script>
-
-      </ul>
-    </div>
-    <div class="footer">
-        &copy; Copyright 2011, Pygame Developers.
-    </div>
-  </body>
-</html>

File docs/index.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>Pygame Front Page &mdash; Pygame v1.9.2 documentation</title>
-    <link rel="stylesheet" href="_static/pygame.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '',
-        VERSION:     '1.9.2',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="_static/jquery.js"></script>
-    <script type="text/javascript" src="_static/underscore.js"></script>
-    <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="shortcut icon" href="_static/pygame.ico"/>
-    <link rel="top" title="Pygame v1.9.2 documentation" href="#" />
-    <link rel="next" title="pygame.camera" href="ref/camera.html" /> 
-  </head>
-  <body>  
-
-    <div class="document">
-
-  <div class="header">
-    <table>
-      <tr>
-	<td class="logo">
-	  <a href="http://www.pygame.org/">
-	    <img src="_static/pygame_tiny.png"/>
-	  </a>
-	  <h5>pygame documentation</h5>
-	</td>
-	<td class="pagelinks">
-	  <p class="top">
-	    ||
-	    <a href="http://www.pygame.org/">Pygame Home</a> ||
-	    <a href="#">Help Contents</a> ||
-	    <a href="genindex.html">Reference Index</a> ||
-	  </p>
-	  <p class="bottom">
-	    <a href="ref/camera.html">camera</a> || 
-	    <a href="ref/cdrom.html">cdrom</a> || 
-	    <a href="ref/color.html">Color</a> || 
-	    <a href="ref/cursors.html">cursors</a> || 
-	    <a href="ref/display.html">display</a> || 
-	    <a href="ref/draw.html">draw</a> || 
-	    <a href="ref/event.html">event</a> || 
-	    <a href="ref/examples.html">examples</a> || 
-	    <a href="ref/font.html">font</a> || 
-	    <a href="ref/freetype.html">freetype</a> || 
-	    <a href="ref/gfxdraw.html">gfxdraw</a> || 
-	    <a href="ref/image.html">image</a> || 
-	    <a href="ref/joystick.html">joystick</a> || 
-	    <a href="ref/key.html">key</a> || 
-	    <a href="ref/locals.html">locals</a> || 
-	    <a href="ref/mask.html">mask</a> || 
-	    <a href="ref/math.html">math</a> || 
-	    <a href="ref/midi.html">midi</a> || 
-	    <a href="ref/mixer.html">mixer</a> || 
-	    <a href="ref/mouse.html">mouse</a> || 
-	    <a href="ref/movie.html">movie</a> || 
-	    <a href="ref/music.html">music</a> || 
-	    <a href="ref/overlay.html">Overlay</a> || 
-	    <a href="ref/pixelarray.html">PixelArray</a> || 
-	    <a href="ref/pixelcopy.html">pixelcopy</a> || 
-	    <a href="ref/pygame.html">pygame</a> || 
-	    <a href="ref/rect.html">Rect</a> || 
-	    <a href="ref/scrap.html">scrap</a> || 
-	    <a href="ref/sndarray.html">sndarray</a> || 
-	    <a href="ref/sprite.html">sprite</a> || 
-	    <a href="ref/surface.html">Surface</a> || 
-	    <a href="ref/surfarray.html">surfarray</a> || 
-	    <a href="ref/tests.html">tests</a> || 
-	    <a href="ref/time.html">time</a> || 
-	    <a href="ref/transform.html">transform</a> || 
-	    <a href="ref/pygame.html#module-pygame.version">version</a>
-	  </p>
-	</td>
-      </tr>
-    </table>
-  </div>
-
-      <div class="documentwrapper">
-          <div class="body">
-            
-  <div class="sectionwrapper">
-<div class="section" id="pygame-front-page">
-<h1>Pygame Front Page<a class="headerlink" href="#pygame-front-page" title="Permalink to this headline">¶</a></h1>
-<div class="toctree-wrapper compound">
-</div>
-<div class="section" id="documents">
-<h2>Documents<a class="headerlink" href="#documents" title="Permalink to this headline">¶</a></h2>
-<dl class="docutils">
-<dt><a class="reference external" href="../readme.html">Readme</a></dt>
-<dd>Basic information about Pygame, what it is, who is involved, and where to find it.</dd>
-<dt><a class="reference external" href="../install.html">Install</a></dt>
-<dd>Steps needed to compile Pygame on several platforms.
-Also help on finding and installing prebuilt binaries for your system.</dd>
-<dt><a class="reference external" href="filepaths.html">File Path Function Arguments</a></dt>
-<dd>How Pygame handles file system paths.</dd>
-<dt><a class="reference external" href="../LGPL">LGPL License</a></dt>
-<dd>This is the license Pygame is distributed under.
-It provides for Pygame to be distributed with open source and commercial software.
-Generally, if Pygame is not changed, it can be used with any type of program.</dd>
-</dl>
-</div>
-<div class="section" id="tutorials">
-<h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this headline">¶</a></h2>
-<dl class="docutils">
-<dt><a class="reference external" href="tut/intro/intro.html">Introduction to Pygame</a></dt>
-<dd>An introduction to the basics of Pygame.
-This is written for users of Python and appeared in volume two of the Py magazine.</dd>
-<dt><a class="reference external" href="tut/ImportInit.html">Import and Initialize</a></dt>
-<dd>The beginning steps on importing and initializing Pygame.
-The Pygame package is made of several modules.
-Some modules are not included on all platforms.</dd>
-<dt><a class="reference external" href="tut/MoveIt.html">How do I move an Image?</a></dt>
-<dd>A basic tutorial that covers the concepts behind 2D computer animation.
-Information about drawing and clearing objects to make them appear animated.</dd>
-<dt><a class="reference external" href="tut/chimp/ChimpLineByLine.html">Chimp Tutorial, Line by Line</a></dt>
-<dd>The pygame examples include a simple program with an interactive fist and a chimpanzee.
-This was inspired by the annoying flash banner of the early 2000&#8217;s.
-This tutorial examines every line of coded used in the example.</dd>
-<dt><a class="reference external" href="tut/SpriteIntro.html">Sprite Module Introduction</a></dt>
-<dd>Pygame includes a higher level sprite module to help organize games.
-The sprite module includes several classes that help manage details found in almost all games types.
-The Sprite classes are a bit more advanced than the regular Pygame modules,
-and need more understanding to be properly used.</dd>
-<dt><a class="reference external" href="tut/surfarray/SurfarrayIntro.html">Surfarray Introduction</a></dt>
-<dd>Pygame used the Numpy python module to allow efficient per pixel effects on images.
-Using the surfae arrays is an advanced feature that allows custom effects and filters.
-This also examines some of the simple effects from the Pygame example, arraydemo.py.</dd>
-<dt><a class="reference external" href="tut/camera/CameraIntro.html">Camera Module Introduction</a></dt>
-<dd>Pygame, as of 1.9, has a camera module that allows you to capture images,
-watch live streams, and do some basic computer vision.
-This tutorial covers those use cases.</dd>
-<dt><a class="reference external" href="tut/newbieguide.html">Newbie Guide</a></dt>
-<dd>A list of thirteen helpful tips for people to get comfortable using Pygame.</dd>
-<dt><a class="reference external" href="tut/tom/MakeGames.html">Making Games Tutorial</a></dt>
-<dd>A large tutorial that covers the bigger topics needed to create an entire game.</dd>
-</dl>
-</div>
-<div class="section" id="reference">
-<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
-<dl class="docutils">
-<dt><a class="reference internal" href="genindex.html"><em>Index</em></a></dt>
-<dd>A list of all functions, classes, and methods in the Pygame package.</dd>
-<dt><a class="reference internal" href="ref/cdrom.html"><em>pygame.cdrom</em></a></dt>
-<dd>How to access and control the CD audio devices.</dd>
-<dt><a class="reference internal" href="ref/color.html"><em>pygame.Color</em></a></dt>
-<dd>Color representation.</dd>
-<dt><a class="reference internal" href="ref/cursors.html"><em>pygame.cursors</em></a></dt>
-<dd>Loading and compiling cursor images.</dd>
-<dt><a class="reference internal" href="ref/display.html"><em>pygame.display</em></a></dt>
-<dd>Configure the display surface.</dd>
-<dt><a class="reference internal" href="ref/draw.html"><em>pygame.draw</em></a></dt>
-<dd>Drawing simple shapes like lines and ellipses to surfaces.</dd>
-<dt><a class="reference internal" href="ref/event.html"><em>pygame.event</em></a></dt>
-<dd>Manage the incoming events from various input devices and the windowing platform.</dd>
-<dt><a class="reference internal" href="ref/examples.html"><em>pygame.examples</em></a></dt>
-<dd>Various programs demonstrating the use of individual pyame modules.</dd>
-<dt><a class="reference internal" href="ref/font.html"><em>pygame.font</em></a></dt>
-<dd>Loading and rendering Truetype fonts.</dd>
-<dt><a class="reference internal" href="ref/freetype.html"><em>pygame.freetype</em></a></dt>
-<dd>Enhanced Pygame module for loading and rendering font faces.</dd>
-<dt><a class="reference internal" href="ref/gfxdraw.html"><em>pygame.gfxdraw</em></a></dt>
-<dd>Anti-aliasing draw functions.</dd>
-<dt><a class="reference internal" href="ref/image.html"><em>pygame.image</em></a></dt>
-<dd>Loading, saving, and transferring of surfaces.</dd>
-<dt><a class="reference internal" href="ref/joystick.html"><em>pygame.joystick</em></a></dt>
-<dd>Manage the joystick devices.</dd>
-<dt><a class="reference internal" href="ref/key.html"><em>pygame.key</em></a></dt>
-<dd>Manage the keyboard device.</dd>
-<dt><a class="reference internal" href="ref/locals.html"><em>pygame.locals</em></a></dt>
-<dd>Pygame constants.</dd>
-<dt><a class="reference internal" href="ref/mixer.html"><em>pygame.mixer</em></a></dt>
-<dd>Load and play sounds</dd>
-<dt><a class="reference internal" href="ref/mouse.html"><em>pygame.mouse</em></a></dt>
-<dd>Manage the mouse device and display.</dd>
-<dt><a class="reference internal" href="ref/movie.html"><em>pygame.movie</em></a></dt>
-<dd>Video playback from MPEG movies.</dd>
-<dt><a class="reference internal" href="ref/music.html"><em>pygame.mixer.music</em></a></dt>
-<dd>Play streaming music tracks.</dd>
-<dt><a class="reference internal" href="ref/overlay.html"><em>pygame.Overlay</em></a></dt>
-<dd>Access advanced video overlays.</dd>
-<dt><a class="reference internal" href="ref/pygame.html"><em>pygame</em></a></dt>
-<dd>Top level functions to manage Pygame.</dd>
-<dt><a class="reference internal" href="ref/pixelarray.html"><em>pygame.PixelArray</em></a></dt>
-<dd>Manipulate image pixel data.</dd>
-<dt><a class="reference internal" href="ref/rect.html"><em>pygame.Rect</em></a></dt>
-<dd>Flexible container for a rectangle.</dd>
-<dt><a class="reference internal" href="ref/scrap.html"><em>pygame.scrap</em></a></dt>
-<dd>Native clipboard access.</dd>
-<dt><a class="reference internal" href="ref/sndarray.html"><em>pygame.sndarray</em></a></dt>
-<dd>Manipulate sound sample data.</dd>
-<dt><a class="reference internal" href="ref/sprite.html"><em>pygame.sprite</em></a></dt>
-<dd>Higher level objects to represent game images.</dd>
-<dt><a class="reference internal" href="ref/surface.html"><em>pygame.Surface</em></a></dt>
-<dd>Objects for images and the screen.</dd>
-<dt><a class="reference internal" href="ref/surfarray.html"><em>pygame.surfarray</em></a></dt>
-<dd>Manipulate image pixel data.</dd>
-<dt><a class="reference internal" href="ref/tests.html"><em>pygame.tests</em></a></dt>
-<dd>Test Pygame.</dd>
-<dt><a class="reference internal" href="ref/time.html"><em>pygame.time</em></a></dt>
-<dd>Manage timing and framerate.</dd>
-<dt><a class="reference internal" href="ref/transform.html"><em>pygame.transform</em></a></dt>
-<dd>Resize and move images.</dd>
-<dt><a class="reference internal" href="search.html"><em>Search Page</em></a></dt>
-<dd>Search Pygame documents by keyword.</dd>
-</dl>
-</div>
-</div>
-
-  </div>
-          </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related">
-      <h3>Navigation</h3>
-      <ul>
-        <li class="right" style="margin-right: 10px">
-          <a href="genindex.html" title="General Index"
-             accesskey="I">index</a></li>
-        <li class="right" >
-          <a href="ref/camera.html" title="pygame.camera"
-             accesskey="N">next</a> |</li>
-        <li><a href="#">Pygame v1.9.2 documentation</a> &raquo;</li>
-    <script type="text/javascript" src="jquery.plugin.docscomments.js"></script>
-
-      </ul>
-    </div>
-    <div class="footer">
-        &copy; Copyright 2011, Pygame Developers.
-    </div>
-  </body>
-</html>

File docs/ref/camera.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>pygame.camera &mdash; Pygame v1.9.2 documentation</title>
-    <link rel="stylesheet" href="../_static/pygame.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '1.9.2',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="shortcut icon" href="../_static/pygame.ico"/>
-    <link rel="top" title="Pygame v1.9.2 documentation" href="../index.html" />
-    <link rel="next" title="pygame.cdrom" href="cdrom.html" />
-    <link rel="prev" title="Pygame Front Page" href="../index.html" /> 
-  </head>
-  <body>  
-
-    <div class="document">
-
-  <div class="header">
-    <table>
-      <tr>
-	<td class="logo">
-	  <a href="http://www.pygame.org/">
-	    <img src="../_static/pygame_tiny.png"/>
-	  </a>
-	  <h5>pygame documentation</h5>
-	</td>
-	<td class="pagelinks">
-	  <p class="top">
-	    ||
-	    <a href="http://www.pygame.org/">Pygame Home</a> ||
-	    <a href="../index.html">Help Contents</a> ||
-	    <a href="../genindex.html">Reference Index</a> ||
-	  </p>
-	  <p class="bottom">
-	    <a href="camera.html">camera</a> || 
-	    <a href="cdrom.html">cdrom</a> || 
-	    <a href="color.html">Color</a> || 
-	    <a href="cursors.html">cursors</a> || 
-	    <a href="display.html">display</a> || 
-	    <a href="draw.html">draw</a> || 
-	    <a href="event.html">event</a> || 
-	    <a href="examples.html">examples</a> || 
-	    <a href="font.html">font</a> || 
-	    <a href="freetype.html">freetype</a> || 
-	    <a href="gfxdraw.html">gfxdraw</a> || 
-	    <a href="image.html">image</a> || 
-	    <a href="joystick.html">joystick</a> || 
-	    <a href="key.html">key</a> || 
-	    <a href="locals.html">locals</a> || 
-	    <a href="mask.html">mask</a> || 
-	    <a href="math.html">math</a> || 
-	    <a href="midi.html">midi</a> || 
-	    <a href="mixer.html">mixer</a> || 
-	    <a href="mouse.html">mouse</a> || 
-	    <a href="movie.html">movie</a> || 
-	    <a href="music.html">music</a> || 
-	    <a href="overlay.html">Overlay</a> || 
-	    <a href="pixelarray.html">PixelArray</a> || 
-	    <a href="pixelcopy.html">pixelcopy</a> || 
-	    <a href="pygame.html">pygame</a> || 
-	    <a href="rect.html">Rect</a> || 
-	    <a href="scrap.html">scrap</a> || 
-	    <a href="sndarray.html">sndarray</a> || 
-	    <a href="sprite.html">sprite</a> || 
-	    <a href="surface.html">Surface</a> || 
-	    <a href="surfarray.html">surfarray</a> || 
-	    <a href="tests.html">tests</a> || 
-	    <a href="time.html">time</a> || 
-	    <a href="transform.html">transform</a> || 
-	    <a href="pygame.html#module-pygame.version">version</a>
-	  </p>
-	</td>
-      </tr>
-    </table>
-  </div>
-
-      <div class="documentwrapper">
-          <div class="body">
-            
-  <div class="sectionwrapper">
-<div class="section" id="module-pygame.camera">
-<span id="pygame-camera"></span><dl class="definition module">
-<dt class="title module">
-<tt class="docutils literal"><span class="pre">pygame.camera</span></tt></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">pygame module for camera use</span></div>
-</div>
-<table border="1" class="toc docutils">
-<colgroup>
-<col width="38%" />
-<col width="1%" />
-<col width="61%" />
-</colgroup>
-<tbody valign="top">
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.colorspace">pygame.camera.colorspace</a></td>
-<td>—</td>
-<td>Surface colorspace conversion</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.list_cameras">pygame.camera.list_cameras</a></td>
-<td>—</td>
-<td>returns a list of available cameras</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera">pygame.camera.Camera</a></td>
-<td>—</td>
-<td>load a camera</td>
-</tr>
-</tbody>
-</table>
-<p>Pygame currently supports only Linux and v4l2 cameras.</p>
-<p>EXPERIMENTAL!: This api may change or disappear in later pygame releases. If
-you use this, your code will very likely break with the next pygame release.</p>
-<p>The Bayer to <tt class="docutils literal"><span class="pre">RGB</span></tt> function is based on:</p>
-<div class="highlight-python"><pre>Sonix SN9C101 based webcam basic I/F routines
-Copyright (C) 2004 Takafumi Mizuno &lt;taka-qce@ls-a.jp&gt;
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.</pre>
-</div>
-<p>New in pygame 1.9.0.</p>
-<dl class="definition function">
-<dt class="title" id="pygame.camera.colorspace">
-<tt class="descclassname">pygame.camera.</tt><tt class="descname">colorspace</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.colorspace" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Surface colorspace conversion</span></div>
-<div class="line"><span class="signature">colorspace(Surface, format, DestSurface = None) -&gt; Surface</span></div>
-</div>
-<p>Allows for conversion from &#8220;RGB&#8221; to a destination colorspace of &#8220;HSV&#8221; or
-&#8220;YUV&#8221;. The source and destination surfaces must be the same size and pixel
-depth. This is useful for computer vision on devices with limited processing
-power. Capture as small of an image as possible, <tt class="docutils literal"><span class="pre">transform.scale()</span></tt> it
-even smaller, and then convert the colorspace to <tt class="docutils literal"><span class="pre">YUV</span></tt> or <tt class="docutils literal"><span class="pre">HSV</span></tt> before
-doing any processing on it.</p>
-</dd></dl>
-
-<dl class="definition function">
-<dt class="title" id="pygame.camera.list_cameras">
-<tt class="descclassname">pygame.camera.</tt><tt class="descname">list_cameras</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.list_cameras" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">returns a list of available cameras</span></div>
-<div class="line"><span class="signature">list_cameras() -&gt; [cameras]</span></div>
-</div>
-<p>Checks the computer for available cameras and returns a list of strings of
-camera names, ready to be fed into <a class="tooltip reference internal" href="#pygame.camera.Camera" title=""><tt class="xref py py-class docutils literal"><span class="pre">pygame.camera.Camera</span></tt><span class="tooltip-content">load a camera</span></a>.</p>
-</dd></dl>
-
-<dl class="definition class">
-<dt class="title" id="pygame.camera.Camera">
-<em class="property">class </em><tt class="descclassname">pygame.camera.</tt><tt class="descname">Camera</tt><a class="headerlink" href="#pygame.camera.Camera" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">load a camera</span></div>
-<div class="line"><span class="signature">Camera(device, (width, height), format) -&gt; Camera</span></div>
-</div>
-<table border="1" class="toc docutils">
-<colgroup>
-<col width="36%" />
-<col width="1%" />
-<col width="63%" />
-</colgroup>
-<tbody valign="top">
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.start">pygame.camera.Camera.start</a></td>
-<td>—</td>
-<td>opens, initializes, and starts capturing</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.stop">pygame.camera.Camera.stop</a></td>
-<td>—</td>
-<td>stops, uninitializes, and closes the camera</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.get_controls">pygame.camera.Camera.get_controls</a></td>
-<td>—</td>
-<td>gets current values of user controls</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.set_controls">pygame.camera.Camera.set_controls</a></td>
-<td>—</td>
-<td>changes camera settings if supported by the camera</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.get_size">pygame.camera.Camera.get_size</a></td>
-<td>—</td>
-<td>returns the dimensions of the images being recorded</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.query_image">pygame.camera.Camera.query_image</a></td>
-<td>—</td>
-<td>checks if a frame is ready</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.get_image">pygame.camera.Camera.get_image</a></td>
-<td>—</td>
-<td>captures an image as a Surface</td>
-</tr>
-<tr><td><a class="toc reference external" href="camera.html#pygame.camera.Camera.get_raw">pygame.camera.Camera.get_raw</a></td>
-<td>—</td>
-<td>returns an unmodified image as a string</td>
-</tr>
-</tbody>
-</table>
-<p>Loads a v4l2 camera. The device is typically something like &#8220;/dev/video0&#8221;.
-Default width and height are 640 by 480. Format is the desired colorspace of
-the output. This is useful for computer vision purposes. The default is
-<tt class="docutils literal"><span class="pre">RGB</span></tt>. The following are supported:</p>
-<blockquote>
-<ul class="simple">
-<li><tt class="docutils literal"><span class="pre">RGB</span></tt> - Red, Green, Blue</li>
-<li><tt class="docutils literal"><span class="pre">YUV</span></tt> - Luma, Blue Chrominance, Red Chrominance</li>
-<li><tt class="docutils literal"><span class="pre">HSV</span></tt> - Hue, Saturation, Value</li>
-</ul>
-</blockquote>
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.start">
-<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.start" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">opens, initializes, and starts capturing</span></div>
-<div class="line"><span class="signature">start() -&gt; None</span></div>
-</div>
-<p>Opens the camera device, attempts to initialize it, and begins recording
-images to a buffer. The camera must be started before any of the below
-functions can be used.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.stop">
-<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.stop" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">stops, uninitializes, and closes the camera</span></div>
-<div class="line"><span class="signature">stop() -&gt; None</span></div>
-</div>
-<p>Stops recording, uninitializes the camera, and closes it. Once a camera
-is stopped, the below functions cannot be used until it is started again.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.get_controls">
-<tt class="descname">get_controls</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.get_controls" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">gets current values of user controls</span></div>
-<div class="line"><span class="signature">get_controls() -&gt; (hflip = bool, vflip = bool, brightness)</span></div>
-</div>
-<p>If the camera supports it, get_controls will return the current settings
-for horizontal and vertical image flip as bools and brightness as an int.
-If unsupported, it will return the default values of (0, 0, 0). Note that
-the return values here may be different than those returned by
-set_controls, though these are more likely to be correct.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.set_controls">
-<tt class="descname">set_controls</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.set_controls" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">changes camera settings if supported by the camera</span></div>
-<div class="line"><span class="signature">set_controls(hflip = bool, vflip = bool, brightness) -&gt; (hflip = bool, vflip = bool, brightness)</span></div>
-</div>
-<p>Allows you to change camera settings if the camera supports it. The
-return values will be the input values if the camera claims it succeeded
-or the values previously in use if not. Each argument is optional, and
-the desired one can be chosen by supplying the keyword, like hflip. Note
-that the actual settings being used by the camera may not be the same as
-those returned by set_controls.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.get_size">
-<tt class="descname">get_size</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.get_size" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">returns the dimensions of the images being recorded</span></div>
-<div class="line"><span class="signature">get_size() -&gt; (width, height)</span></div>
-</div>
-<p>Returns the current dimensions of the images being captured by the
-camera. This will return the actual size, which may be different than the
-one specified during initialization if the camera did not support that
-size.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.query_image">
-<tt class="descname">query_image</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.query_image" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">checks if a frame is ready</span></div>
-<div class="line"><span class="signature">query_image() -&gt; bool</span></div>
-</div>
-<p>If an image is ready to get, it returns true. Otherwise it returns false.
-Note that some webcams will always return False and will only queue a
-frame when called with a blocking function like <tt class="docutils literal"><span class="pre">get_image()</span></tt>. This is
-useful to separate the framerate of the game from that of the camera
-without having to use threading.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.get_image">
-<tt class="descname">get_image</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.get_image" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">captures an image as a Surface</span></div>
-<div class="line"><span class="signature">get_image(Surface = None) -&gt; Surface</span></div>
-</div>
-<p>Pulls an image off of the buffer as an <tt class="docutils literal"><span class="pre">RGB</span></tt> Surface. It can optionally
-reuse an existing Surface to save time. The bit depth of the surface is
-either 24bits or the same as the optionally supplied Surface.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.camera.Camera.get_raw">
-<tt class="descname">get_raw</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.camera.Camera.get_raw" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">returns an unmodified image as a string</span></div>
-<div class="line"><span class="signature">get_raw() -&gt; string</span></div>
-</div>
-<p>Gets an image from a camera as a string in the native pixelformat of the
-camera. Useful for integration with other libraries.</p>
-</dd></dl>
-
-</dd></dl>
-
-</dd></dl>
-
-</div>
-
-  </div>
-          </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related">
-      <h3>Navigation</h3>
-      <ul>
-        <li class="right" style="margin-right: 10px">
-          <a href="../genindex.html" title="General Index"
-             accesskey="I">index</a></li>
-        <li class="right" >
-          <a href="cdrom.html" title="pygame.cdrom"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="../index.html" title="Pygame Front Page"
-             accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">Pygame v1.9.2 documentation</a> &raquo;</li>
-    <script type="text/javascript" src="jquery.plugin.docscomments.js"></script>
-
-      </ul>
-    </div>
-    <div class="footer">
-        &copy; Copyright 2011, Pygame Developers.
-    </div>
-  </body>
-</html>

File docs/ref/cdrom.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>pygame.cdrom &mdash; Pygame v1.9.2 documentation</title>
-    <link rel="stylesheet" href="../_static/pygame.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '1.9.2',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="shortcut icon" href="../_static/pygame.ico"/>
-    <link rel="top" title="Pygame v1.9.2 documentation" href="../index.html" />
-    <link rel="next" title="pygame.Color" href="color.html" />
-    <link rel="prev" title="pygame.camera" href="camera.html" /> 
-  </head>
-  <body>  
-
-    <div class="document">
-
-  <div class="header">
-    <table>
-      <tr>
-	<td class="logo">
-	  <a href="http://www.pygame.org/">
-	    <img src="../_static/pygame_tiny.png"/>
-	  </a>
-	  <h5>pygame documentation</h5>
-	</td>
-	<td class="pagelinks">
-	  <p class="top">
-	    ||
-	    <a href="http://www.pygame.org/">Pygame Home</a> ||
-	    <a href="../index.html">Help Contents</a> ||
-	    <a href="../genindex.html">Reference Index</a> ||
-	  </p>
-	  <p class="bottom">
-	    <a href="camera.html">camera</a> || 
-	    <a href="cdrom.html">cdrom</a> || 
-	    <a href="color.html">Color</a> || 
-	    <a href="cursors.html">cursors</a> || 
-	    <a href="display.html">display</a> || 
-	    <a href="draw.html">draw</a> || 
-	    <a href="event.html">event</a> || 
-	    <a href="examples.html">examples</a> || 
-	    <a href="font.html">font</a> || 
-	    <a href="freetype.html">freetype</a> || 
-	    <a href="gfxdraw.html">gfxdraw</a> || 
-	    <a href="image.html">image</a> || 
-	    <a href="joystick.html">joystick</a> || 
-	    <a href="key.html">key</a> || 
-	    <a href="locals.html">locals</a> || 
-	    <a href="mask.html">mask</a> || 
-	    <a href="math.html">math</a> || 
-	    <a href="midi.html">midi</a> || 
-	    <a href="mixer.html">mixer</a> || 
-	    <a href="mouse.html">mouse</a> || 
-	    <a href="movie.html">movie</a> || 
-	    <a href="music.html">music</a> || 
-	    <a href="overlay.html">Overlay</a> || 
-	    <a href="pixelarray.html">PixelArray</a> || 
-	    <a href="pixelcopy.html">pixelcopy</a> || 
-	    <a href="pygame.html">pygame</a> || 
-	    <a href="rect.html">Rect</a> || 
-	    <a href="scrap.html">scrap</a> || 
-	    <a href="sndarray.html">sndarray</a> || 
-	    <a href="sprite.html">sprite</a> || 
-	    <a href="surface.html">Surface</a> || 
-	    <a href="surfarray.html">surfarray</a> || 
-	    <a href="tests.html">tests</a> || 
-	    <a href="time.html">time</a> || 
-	    <a href="transform.html">transform</a> || 
-	    <a href="pygame.html#module-pygame.version">version</a>
-	  </p>
-	</td>
-      </tr>
-    </table>
-  </div>
-
-      <div class="documentwrapper">
-          <div class="body">
-            
-  <div class="sectionwrapper">
-<div class="section" id="module-pygame.cdrom">
-<span id="pygame-cdrom"></span><dl class="definition module">
-<dt class="title module">
-<tt class="docutils literal"><span class="pre">pygame.cdrom</span></tt></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">pygame module for audio cdrom control</span></div>
-</div>
-<table border="1" class="toc docutils">
-<colgroup>
-<col width="32%" />
-<col width="1%" />
-<col width="66%" />
-</colgroup>
-<tbody valign="top">
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.init">pygame.cdrom.init</a></td>
-<td>—</td>
-<td>initialize the cdrom module</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.quit">pygame.cdrom.quit</a></td>
-<td>—</td>
-<td>uninitialize the cdrom module</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.get_init">pygame.cdrom.get_init</a></td>
-<td>—</td>
-<td>true if the cdrom module is initialized</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.get_count">pygame.cdrom.get_count</a></td>
-<td>—</td>
-<td>number of cd drives on the system</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD">pygame.cdrom.CD</a></td>
-<td>—</td>
-<td>class to manage a cdrom drive</td>
-</tr>
-</tbody>
-</table>
-<p>The cdrom module manages the <tt class="docutils literal"><span class="pre">CD</span></tt> and <tt class="docutils literal"><span class="pre">DVD</span></tt> drives on a computer. It can
-also control the playback of audio cd&#8217;s. This module needs to be initialized
-before it can do anything. Each <tt class="docutils literal"><span class="pre">CD</span></tt> object you create represents a cdrom
-drive and must also be initialized individually before it can do most things.</p>
-<dl class="definition function">
-<dt class="title" id="pygame.cdrom.init">
-<tt class="descclassname">pygame.cdrom.</tt><tt class="descname">init</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.init" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">initialize the cdrom module</span></div>
-<div class="line"><span class="signature">init() -&gt; None</span></div>
-</div>
-<p>Initialize the cdrom module. This will scan the system for all <tt class="docutils literal"><span class="pre">CD</span></tt>
-devices. The module must be initialized before any other functions will
-work. This automatically happens when you call <tt class="docutils literal"><span class="pre">pygame.init()</span></tt>.</p>
-<p>It is safe to call this function more than once.</p>
-</dd></dl>
-
-<dl class="definition function">
-<dt class="title" id="pygame.cdrom.quit">
-<tt class="descclassname">pygame.cdrom.</tt><tt class="descname">quit</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.quit" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">uninitialize the cdrom module</span></div>
-<div class="line"><span class="signature">quit() -&gt; None</span></div>
-</div>
-<p>Uninitialize the cdrom module. After you call this any existing <tt class="docutils literal"><span class="pre">CD</span></tt>
-objects will no longer work.</p>
-<p>It is safe to call this function more than once.</p>
-</dd></dl>
-
-<dl class="definition function">
-<dt class="title" id="pygame.cdrom.get_init">
-<tt class="descclassname">pygame.cdrom.</tt><tt class="descname">get_init</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.get_init" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">true if the cdrom module is initialized</span></div>
-<div class="line"><span class="signature">get_init() -&gt; bool</span></div>
-</div>
-<p>Test if the cdrom module is initialized or not. This is different than the
-<tt class="docutils literal"><span class="pre">CD.init()</span></tt> since each drive must also be initialized individually.</p>
-</dd></dl>
-
-<dl class="definition function">
-<dt class="title" id="pygame.cdrom.get_count">
-<tt class="descclassname">pygame.cdrom.</tt><tt class="descname">get_count</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.get_count" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">number of cd drives on the system</span></div>
-<div class="line"><span class="signature">get_count() -&gt; count</span></div>
-</div>
-<p>Return the number of cd drives on the system. When you create <tt class="docutils literal"><span class="pre">CD</span></tt> objects
-you need to pass an integer id that must be lower than this count. The count
-will be 0 if there are no drives on the system.</p>
-</dd></dl>
-
-<dl class="definition class">
-<dt class="title" id="pygame.cdrom.CD">
-<em class="property">class </em><tt class="descclassname">pygame.cdrom.</tt><tt class="descname">CD</tt><a class="headerlink" href="#pygame.cdrom.CD" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">class to manage a cdrom drive</span></div>
-<div class="line"><span class="signature">CD(id) -&gt; CD</span></div>
-</div>
-<table border="1" class="toc docutils">
-<colgroup>
-<col width="41%" />
-<col width="1%" />
-<col width="58%" />
-</colgroup>
-<tbody valign="top">
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.init">pygame.cdrom.CD.init</a></td>
-<td>—</td>
-<td>initialize a cdrom drive for use</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.quit">pygame.cdrom.CD.quit</a></td>
-<td>—</td>
-<td>uninitialize a cdrom drive for use</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_init">pygame.cdrom.CD.get_init</a></td>
-<td>—</td>
-<td>true if this cd device initialized</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.play">pygame.cdrom.CD.play</a></td>
-<td>—</td>
-<td>start playing audio</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.stop">pygame.cdrom.CD.stop</a></td>
-<td>—</td>
-<td>stop audio playback</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.pause">pygame.cdrom.CD.pause</a></td>
-<td>—</td>
-<td>temporarily stop audio playback</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.resume">pygame.cdrom.CD.resume</a></td>
-<td>—</td>
-<td>unpause audio playback</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.eject">pygame.cdrom.CD.eject</a></td>
-<td>—</td>
-<td>eject or open the cdrom drive</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_id">pygame.cdrom.CD.get_id</a></td>
-<td>—</td>
-<td>the index of the cdrom drive</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_name">pygame.cdrom.CD.get_name</a></td>
-<td>—</td>
-<td>the system name of the cdrom drive</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_busy">pygame.cdrom.CD.get_busy</a></td>
-<td>—</td>
-<td>true if the drive is playing audio</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_paused">pygame.cdrom.CD.get_paused</a></td>
-<td>—</td>
-<td>true if the drive is paused</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_current">pygame.cdrom.CD.get_current</a></td>
-<td>—</td>
-<td>the current audio playback position</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_empty">pygame.cdrom.CD.get_empty</a></td>
-<td>—</td>
-<td>False if a cdrom is in the drive</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_numtracks">pygame.cdrom.CD.get_numtracks</a></td>
-<td>—</td>
-<td>the number of tracks on the cdrom</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_track_audio">pygame.cdrom.CD.get_track_audio</a></td>
-<td>—</td>
-<td>true if the cdrom track has audio data</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_all">pygame.cdrom.CD.get_all</a></td>
-<td>—</td>
-<td>get all track information</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_track_start">pygame.cdrom.CD.get_track_start</a></td>
-<td>—</td>
-<td>start time of a cdrom track</td>
-</tr>
-<tr><td><a class="toc reference external" href="cdrom.html#pygame.cdrom.CD.get_track_length">pygame.cdrom.CD.get_track_length</a></td>
-<td>—</td>
-<td>length of a cdrom track</td>
-</tr>
-</tbody>
-</table>
-<p>You can create a <tt class="docutils literal"><span class="pre">CD</span></tt> object for each cdrom on the system. Use
-<tt class="docutils literal"><span class="pre">pygame.cdrom.get_count()</span></tt> to determine how many drives actually exist.
-The id argument is an integer of the drive, starting at zero.</p>
-<p>The <tt class="docutils literal"><span class="pre">CD</span></tt> object is not initialized, you can only call <tt class="docutils literal"><span class="pre">CD.get_id()</span></tt> and
-<tt class="docutils literal"><span class="pre">CD.get_name()</span></tt> on an uninitialized drive.</p>
-<p>It is safe to create multiple <tt class="docutils literal"><span class="pre">CD</span></tt> objects for the same drive, they will
-all cooperate normally.</p>
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.init">
-<tt class="descname">init</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.init" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">initialize a cdrom drive for use</span></div>
-<div class="line"><span class="signature">init() -&gt; None</span></div>
-</div>
-<p>Initialize the cdrom drive for use. The drive must be initialized for
-most <tt class="docutils literal"><span class="pre">CD</span></tt> methods to work. Even if the rest of pygame has been
-initialized.</p>
-<p>There may be a brief pause while the drive is initialized. Avoid
-<tt class="docutils literal"><span class="pre">CD.init()</span></tt> if the program should not stop for a second or two.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.quit">
-<tt class="descname">quit</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.quit" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">uninitialize a cdrom drive for use</span></div>
-<div class="line"><span class="signature">quit() -&gt; None</span></div>
-</div>
-<p>Uninitialize a drive for use. Call this when your program will not be
-accessing the drive for awhile.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_init">
-<tt class="descname">get_init</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_init" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">true if this cd device initialized</span></div>
-<div class="line"><span class="signature">get_init() -&gt; bool</span></div>
-</div>
-<p>Test if this <tt class="docutils literal"><span class="pre">CDROM</span></tt> device is initialized. This is different than the
-<tt class="docutils literal"><span class="pre">pygame.cdrom.init()</span></tt> since each drive must also be initialized
-individually.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.play">
-<tt class="descname">play</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.play" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">start playing audio</span></div>
-<div class="line"><span class="signature">play(track, start=None, end=None) -&gt; None</span></div>
-</div>
-<p>Playback audio from an audio cdrom in the drive. Besides the track number
-argument, you can also pass a starting and ending time for playback. The
-start and end time are in seconds, and can limit the section of an audio
-track played.</p>
-<p>If you pass a start time but no end, the audio will play to the end of
-the track. If you pass a start time and &#8216;None&#8217; for the end time, the
-audio will play to the end of the entire disc.</p>
-<p>See the <tt class="docutils literal"><span class="pre">CD.get_numtracks()</span></tt> and <tt class="docutils literal"><span class="pre">CD.get_track_audio()</span></tt> to find
-tracks to playback.</p>
-<p>Note, track 0 is the first track on the <tt class="docutils literal"><span class="pre">CD</span></tt>. Track numbers start at
-zero.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.stop">
-<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.stop" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">stop audio playback</span></div>
-<div class="line"><span class="signature">stop() -&gt; None</span></div>
-</div>
-<p>Stops playback of audio from the cdrom. This will also lose the current
-playback position. This method does nothing if the drive isn&#8217;t already
-playing audio.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.pause">
-<tt class="descname">pause</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.pause" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">temporarily stop audio playback</span></div>
-<div class="line"><span class="signature">pause() -&gt; None</span></div>
-</div>
-<p>Temporarily stop audio playback on the <tt class="docutils literal"><span class="pre">CD</span></tt>. The playback can be
-resumed at the same point with the <tt class="docutils literal"><span class="pre">CD.resume()</span></tt> method. If the <tt class="docutils literal"><span class="pre">CD</span></tt>
-is not playing this method does nothing.</p>
-<p>Note, track 0 is the first track on the <tt class="docutils literal"><span class="pre">CD</span></tt>. Track numbers start at
-zero.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.resume">
-<tt class="descname">resume</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.resume" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">unpause audio playback</span></div>
-<div class="line"><span class="signature">resume() -&gt; None</span></div>
-</div>
-<p>Unpause a paused <tt class="docutils literal"><span class="pre">CD</span></tt>. If the <tt class="docutils literal"><span class="pre">CD</span></tt> is not paused or already playing,
-this method does nothing.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.eject">
-<tt class="descname">eject</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.eject" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">eject or open the cdrom drive</span></div>
-<div class="line"><span class="signature">eject() -&gt; None</span></div>
-</div>
-<p>This will open the cdrom drive and eject the cdrom. If the drive is
-playing or paused it will be stopped.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_id">
-<tt class="descname">get_id</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_id" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">the index of the cdrom drive</span></div>
-<div class="line"><span class="signature">get_id() -&gt; id</span></div>
-</div>
-<p>Returns the integer id that was used to create the <tt class="docutils literal"><span class="pre">CD</span></tt> instance. This
-method can work on an uninitialized <tt class="docutils literal"><span class="pre">CD</span></tt>.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_name">
-<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_name" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">the system name of the cdrom drive</span></div>
-<div class="line"><span class="signature">get_name() -&gt; name</span></div>
-</div>
-<p>Return the string name of the drive. This is the system name used to
-represent the drive. It is often the drive letter or device name. This
-method can work on an uninitialized <tt class="docutils literal"><span class="pre">CD</span></tt>.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_busy">
-<tt class="descname">get_busy</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_busy" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">true if the drive is playing audio</span></div>
-<div class="line"><span class="signature">get_busy() -&gt; bool</span></div>
-</div>
-<p>Returns True if the drive busy playing back audio.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_paused">
-<tt class="descname">get_paused</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_paused" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">true if the drive is paused</span></div>
-<div class="line"><span class="signature">get_paused() -&gt; bool</span></div>
-</div>
-<p>Returns True if the drive is currently paused.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_current">
-<tt class="descname">get_current</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_current" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">the current audio playback position</span></div>
-<div class="line"><span class="signature">get_current() -&gt; track, seconds</span></div>
-</div>
-<p>Returns both the current track and time of that track. This method works
-when the drive is either playing or paused.</p>
-<p>Note, track 0 is the first track on the <tt class="docutils literal"><span class="pre">CD</span></tt>. Track numbers start at
-zero.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_empty">
-<tt class="descname">get_empty</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_empty" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">False if a cdrom is in the drive</span></div>
-<div class="line"><span class="signature">get_empty() -&gt; bool</span></div>
-</div>
-<p>Return False if there is a cdrom currently in the drive. If the drive is
-empty this will return True.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_numtracks">
-<tt class="descname">get_numtracks</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_numtracks" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">the number of tracks on the cdrom</span></div>
-<div class="line"><span class="signature">get_numtracks() -&gt; count</span></div>
-</div>
-<p>Return the number of tracks on the cdrom in the drive. This will return
-zero of the drive is empty or has no tracks.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_track_audio">
-<tt class="descname">get_track_audio</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_track_audio" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">true if the cdrom track has audio data</span></div>
-<div class="line"><span class="signature">get_track_audio(track) -&gt; bool</span></div>
-</div>
-<p>Determine if a track on a cdrom contains audio data. You can also call
-<tt class="docutils literal"><span class="pre">CD.num_tracks()</span></tt> and <tt class="docutils literal"><span class="pre">CD.get_all()</span></tt> to determine more information
-about the cdrom.</p>
-<p>Note, track 0 is the first track on the <tt class="docutils literal"><span class="pre">CD</span></tt>. Track numbers start at
-zero.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_all">
-<tt class="descname">get_all</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_all" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">get all track information</span></div>
-<div class="line"><span class="signature">get_all() -&gt; [(audio, start, end, lenth), ...]</span></div>
-</div>
-<p>Return a list with information for every track on the cdrom. The
-information consists of a tuple with four values. The audio value is True
-if the track contains audio data. The start, end, and length values are
-floating point numbers in seconds. Start and end represent absolute times
-on the entire disc.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_track_start">
-<tt class="descname">get_track_start</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_track_start" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">start time of a cdrom track</span></div>
-<div class="line"><span class="signature">get_track_start(track) -&gt; seconds</span></div>
-</div>
-<p>Return the absolute time in seconds where at start of the cdrom track.</p>
-<p>Note, track 0 is the first track on the <tt class="docutils literal"><span class="pre">CD</span></tt>. Track numbers start at
-zero.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.cdrom.CD.get_track_length">
-<tt class="descname">get_track_length</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cdrom.CD.get_track_length" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">length of a cdrom track</span></div>
-<div class="line"><span class="signature">get_track_length(track) -&gt; seconds</span></div>
-</div>
-<p>Return a floating point value in seconds of the length of the cdrom
-track.</p>
-<p>Note, track 0 is the first track on the <tt class="docutils literal"><span class="pre">CD</span></tt>. Track numbers start at
-zero.</p>
-</dd></dl>
-
-</dd></dl>
-
-</dd></dl>
-
-</div>
-
-  </div>
-          </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related">
-      <h3>Navigation</h3>
-      <ul>
-        <li class="right" style="margin-right: 10px">
-          <a href="../genindex.html" title="General Index"
-             accesskey="I">index</a></li>
-        <li class="right" >
-          <a href="color.html" title="pygame.Color"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="camera.html" title="pygame.camera"
-             accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">Pygame v1.9.2 documentation</a> &raquo;</li>
-    <script type="text/javascript" src="jquery.plugin.docscomments.js"></script>
-
-      </ul>
-    </div>
-    <div class="footer">
-        &copy; Copyright 2011, Pygame Developers.
-    </div>
-  </body>
-</html>

File docs/ref/color.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>pygame.Color &mdash; Pygame v1.9.2 documentation</title>
-    <link rel="stylesheet" href="../_static/pygame.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '1.9.2',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="shortcut icon" href="../_static/pygame.ico"/>
-    <link rel="top" title="Pygame v1.9.2 documentation" href="../index.html" />
-    <link rel="next" title="pygame.cursors" href="cursors.html" />
-    <link rel="prev" title="pygame.cdrom" href="cdrom.html" /> 
-  </head>
-  <body>  
-
-    <div class="document">
-
-  <div class="header">
-    <table>
-      <tr>
-	<td class="logo">
-	  <a href="http://www.pygame.org/">
-	    <img src="../_static/pygame_tiny.png"/>
-	  </a>
-	  <h5>pygame documentation</h5>
-	</td>
-	<td class="pagelinks">
-	  <p class="top">
-	    ||
-	    <a href="http://www.pygame.org/">Pygame Home</a> ||
-	    <a href="../index.html">Help Contents</a> ||
-	    <a href="../genindex.html">Reference Index</a> ||
-	  </p>
-	  <p class="bottom">
-	    <a href="camera.html">camera</a> || 
-	    <a href="cdrom.html">cdrom</a> || 
-	    <a href="color.html">Color</a> || 
-	    <a href="cursors.html">cursors</a> || 
-	    <a href="display.html">display</a> || 
-	    <a href="draw.html">draw</a> || 
-	    <a href="event.html">event</a> || 
-	    <a href="examples.html">examples</a> || 
-	    <a href="font.html">font</a> || 
-	    <a href="freetype.html">freetype</a> || 
-	    <a href="gfxdraw.html">gfxdraw</a> || 
-	    <a href="image.html">image</a> || 
-	    <a href="joystick.html">joystick</a> || 
-	    <a href="key.html">key</a> || 
-	    <a href="locals.html">locals</a> || 
-	    <a href="mask.html">mask</a> || 
-	    <a href="math.html">math</a> || 
-	    <a href="midi.html">midi</a> || 
-	    <a href="mixer.html">mixer</a> || 
-	    <a href="mouse.html">mouse</a> || 
-	    <a href="movie.html">movie</a> || 
-	    <a href="music.html">music</a> || 
-	    <a href="overlay.html">Overlay</a> || 
-	    <a href="pixelarray.html">PixelArray</a> || 
-	    <a href="pixelcopy.html">pixelcopy</a> || 
-	    <a href="pygame.html">pygame</a> || 
-	    <a href="rect.html">Rect</a> || 
-	    <a href="scrap.html">scrap</a> || 
-	    <a href="sndarray.html">sndarray</a> || 
-	    <a href="sprite.html">sprite</a> || 
-	    <a href="surface.html">Surface</a> || 
-	    <a href="surfarray.html">surfarray</a> || 
-	    <a href="tests.html">tests</a> || 
-	    <a href="time.html">time</a> || 
-	    <a href="transform.html">transform</a> || 
-	    <a href="pygame.html#module-pygame.version">version</a>
-	  </p>
-	</td>
-      </tr>
-    </table>
-  </div>
-
-      <div class="documentwrapper">
-          <div class="body">
-            
-  <div class="sectionwrapper">
-<div class="section" id="pygame-color">
-<dl class="definition class">
-<dt class="title" id="pygame.Color">
-<em class="property">class </em><tt class="descclassname">pygame.</tt><tt class="descname">Color</tt><a class="headerlink" href="#pygame.Color" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">pygame object for color representations</span></div>
-<div class="line"><span class="signature">Color(name) -&gt; Color</span></div>
-<div class="line"><span class="signature">Color(r, g, b, a) -&gt; Color</span></div>
-<div class="line"><span class="signature">Color(rgbvalue) -&gt; Color</span></div>
-</div>
-<table border="1" class="toc docutils">
-<colgroup>
-<col width="30%" />
-<col width="1%" />
-<col width="69%" />
-</colgroup>
-<tbody valign="top">
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.r">pygame.Color.r</a></td>
-<td>—</td>
-<td>Gets or sets the red value of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.g">pygame.Color.g</a></td>
-<td>—</td>
-<td>Gets or sets the green value of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.b">pygame.Color.b</a></td>
-<td>—</td>
-<td>Gets or sets the blue value of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.a">pygame.Color.a</a></td>
-<td>—</td>
-<td>Gets or sets the alpha value of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.cmy">pygame.Color.cmy</a></td>
-<td>—</td>
-<td>Gets or sets the CMY representation of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.hsva">pygame.Color.hsva</a></td>
-<td>—</td>
-<td>Gets or sets the HSVA representation of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.hsla">pygame.Color.hsla</a></td>
-<td>—</td>
-<td>Gets or sets the HSLA representation of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.i1i2i3">pygame.Color.i1i2i3</a></td>
-<td>—</td>
-<td>Gets or sets the I1I2I3 representation of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.normalize">pygame.Color.normalize</a></td>
-<td>—</td>
-<td>Returns the normalized RGBA values of the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.correct_gamma">pygame.Color.correct_gamma</a></td>
-<td>—</td>
-<td>Applies a certain gamma value to the Color.</td>
-</tr>
-<tr><td><a class="toc reference external" href="color.html#pygame.Color.set_length">pygame.Color.set_length</a></td>
-<td>—</td>
-<td>Set the number of elements in the Color to 1,2,3, or 4.</td>
-</tr>
-</tbody>
-</table>
-<p>The Color class represents <tt class="docutils literal"><span class="pre">RGBA</span></tt> color values using a value range of
-0-255. It allows basic arithmetic operations to create new colors, supports
-conversions to other color spaces such as <tt class="docutils literal"><span class="pre">HSV</span></tt> or <tt class="docutils literal"><span class="pre">HSL</span></tt> and lets you
-adjust single color channels. Alpha defaults to 255 when not given.</p>
-<p>&#8216;rgbvalue&#8217; can be either a color name, an <tt class="docutils literal"><span class="pre">HTML</span></tt> color format string, a
-hex number string, or an integer pixel value. The <tt class="docutils literal"><span class="pre">HTML</span></tt> format is
-&#8216;#rrggbbaa&#8217;, where rr, gg, bb, and aa are 2 digit hex numbers. The alpha aa
-is optional. A hex number string has the form &#8216;0xrrggbbaa&#8217;, where aa is
-optional.</p>
-<p>Color objects support equality comparison with other color objects and 3 or
-4 element tuples of integers (New in 1.9.0). There was a bug in pygame 1.8.1
-where the default alpha was 0, not 255 like previously.</p>
-<p>New implementation of Color was done in pygame 1.8.1.</p>
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.r">
-<tt class="descname">r</tt><a class="headerlink" href="#pygame.Color.r" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the red value of the Color.</span></div>
-<div class="line"><span class="signature">r -&gt; int</span></div>
-</div>
-<p>The red value of the Color.</p>
-</dd></dl>
-
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.g">
-<tt class="descname">g</tt><a class="headerlink" href="#pygame.Color.g" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the green value of the Color.</span></div>
-<div class="line"><span class="signature">g -&gt; int</span></div>
-</div>
-<p>The green value of the Color.</p>
-</dd></dl>
-
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.b">
-<tt class="descname">b</tt><a class="headerlink" href="#pygame.Color.b" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the blue value of the Color.</span></div>
-<div class="line"><span class="signature">b -&gt; int</span></div>
-</div>
-<p>The blue value of the Color.</p>
-</dd></dl>
-
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.a">
-<tt class="descname">a</tt><a class="headerlink" href="#pygame.Color.a" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the alpha value of the Color.</span></div>
-<div class="line"><span class="signature">a -&gt; int</span></div>
-</div>
-<p>The alpha value of the Color.</p>
-</dd></dl>
-
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.cmy">
-<tt class="descname">cmy</tt><a class="headerlink" href="#pygame.Color.cmy" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the CMY representation of the Color.</span></div>
-<div class="line"><span class="signature">cmy -&gt; tuple</span></div>
-</div>
-<p>The <tt class="docutils literal"><span class="pre">CMY</span></tt> representation of the Color. The <tt class="docutils literal"><span class="pre">CMY</span></tt> components are in
-the ranges <tt class="docutils literal"><span class="pre">C</span></tt> = [0, 1], <tt class="docutils literal"><span class="pre">M</span></tt> = [0, 1], <tt class="docutils literal"><span class="pre">Y</span></tt> = [0, 1]. Note that this
-will not return the absolutely exact <tt class="docutils literal"><span class="pre">CMY</span></tt> values for the set <tt class="docutils literal"><span class="pre">RGB</span></tt>
-values in all cases. Due to the <tt class="docutils literal"><span class="pre">RGB</span></tt> mapping from 0-255 and the
-<tt class="docutils literal"><span class="pre">CMY</span></tt> mapping from 0-1 rounding errors may cause the <tt class="docutils literal"><span class="pre">CMY</span></tt> values to
-differ slightly from what you might expect.</p>
-</dd></dl>
-
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.hsva">
-<tt class="descname">hsva</tt><a class="headerlink" href="#pygame.Color.hsva" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the HSVA representation of the Color.</span></div>
-<div class="line"><span class="signature">hsva -&gt; tuple</span></div>
-</div>
-<p>The <tt class="docutils literal"><span class="pre">HSVA</span></tt> representation of the Color. The <tt class="docutils literal"><span class="pre">HSVA</span></tt> components are in
-the ranges <tt class="docutils literal"><span class="pre">H</span></tt> = [0, 360], <tt class="docutils literal"><span class="pre">S</span></tt> = [0, 100], <tt class="docutils literal"><span class="pre">V</span></tt> = [0, 100], A = [0,
-100]. Note that this will not return the absolutely exact <tt class="docutils literal"><span class="pre">HSV</span></tt> values
-for the set <tt class="docutils literal"><span class="pre">RGB</span></tt> values in all cases. Due to the <tt class="docutils literal"><span class="pre">RGB</span></tt> mapping from
-0-255 and the <tt class="docutils literal"><span class="pre">HSV</span></tt> mapping from 0-100 and 0-360 rounding errors may
-cause the <tt class="docutils literal"><span class="pre">HSV</span></tt> values to differ slightly from what you might expect.</p>
-</dd></dl>
-
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.hsla">
-<tt class="descname">hsla</tt><a class="headerlink" href="#pygame.Color.hsla" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the HSLA representation of the Color.</span></div>
-<div class="line"><span class="signature">hsla -&gt; tuple</span></div>
-</div>
-<p>The <tt class="docutils literal"><span class="pre">HSLA</span></tt> representation of the Color. The <tt class="docutils literal"><span class="pre">HSLA</span></tt> components are in
-the ranges <tt class="docutils literal"><span class="pre">H</span></tt> = [0, 360], <tt class="docutils literal"><span class="pre">S</span></tt> = [0, 100], <tt class="docutils literal"><span class="pre">V</span></tt> = [0, 100], A = [0,
-100]. Note that this will not return the absolutely exact <tt class="docutils literal"><span class="pre">HSL</span></tt> values
-for the set <tt class="docutils literal"><span class="pre">RGB</span></tt> values in all cases. Due to the <tt class="docutils literal"><span class="pre">RGB</span></tt> mapping from
-0-255 and the <tt class="docutils literal"><span class="pre">HSL</span></tt> mapping from 0-100 and 0-360 rounding errors may
-cause the <tt class="docutils literal"><span class="pre">HSL</span></tt> values to differ slightly from what you might expect.</p>
-</dd></dl>
-
-<dl class="definition attribute">
-<dt class="title" id="pygame.Color.i1i2i3">
-<tt class="descname">i1i2i3</tt><a class="headerlink" href="#pygame.Color.i1i2i3" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Gets or sets the I1I2I3 representation of the Color.</span></div>
-<div class="line"><span class="signature">i1i2i3 -&gt; tuple</span></div>
-</div>
-<p>The <tt class="docutils literal"><span class="pre">I1I2I3</span></tt> representation of the Color. The <tt class="docutils literal"><span class="pre">I1I2I3</span></tt> components are
-in the ranges <tt class="docutils literal"><span class="pre">I1</span></tt> = [0, 1], <tt class="docutils literal"><span class="pre">I2</span></tt> = [-0.5, 0.5], <tt class="docutils literal"><span class="pre">I3</span></tt> = [-0.5,
-0.5]. Note that this will not return the absolutely exact <tt class="docutils literal"><span class="pre">I1I2I3</span></tt>
-values for the set <tt class="docutils literal"><span class="pre">RGB</span></tt> values in all cases. Due to the <tt class="docutils literal"><span class="pre">RGB</span></tt>
-mapping from 0-255 and the <tt class="docutils literal"><span class="pre">I1I2I3</span></tt> mapping from 0-1 rounding errors
-may cause the <tt class="docutils literal"><span class="pre">I1I2I3</span></tt> values to differ slightly from what you might
-expect.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.Color.normalize">
-<tt class="descname">normalize</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.Color.normalize" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Returns the normalized RGBA values of the Color.</span></div>
-<div class="line"><span class="signature">normalize() -&gt; tuple</span></div>
-</div>
-<p>Returns the normalized <tt class="docutils literal"><span class="pre">RGBA</span></tt> values of the Color as floating point
-values.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.Color.correct_gamma">
-<tt class="descname">correct_gamma</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.Color.correct_gamma" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Applies a certain gamma value to the Color.</span></div>
-<div class="line"><span class="signature">correct_gamma (gamma) -&gt; Color</span></div>
-</div>
-<p>Applies a certain gamma value to the Color and returns a new Color with
-the adjusted <tt class="docutils literal"><span class="pre">RGBA</span></tt> values.</p>
-</dd></dl>
-
-<dl class="definition method">
-<dt class="title" id="pygame.Color.set_length">
-<tt class="descname">set_length</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.Color.set_length" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">Set the number of elements in the Color to 1,2,3, or 4.</span></div>
-<div class="line"><span class="signature">set_length(len) -&gt; None</span></div>
-</div>
-<p>The default Color length is 4. Colors can have lengths 1,2,3 or 4. This
-is useful if you want to unpack to r,g,b and not r,g,b,a. If you want to
-get the length of a Color do <tt class="docutils literal"><span class="pre">len(acolor)</span></tt>.</p>
-<p>New in pygame 1.9.0.</p>
-</dd></dl>
-
-</dd></dl>
-
-</div>
-
-  </div>
-          </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related">
-      <h3>Navigation</h3>
-      <ul>
-        <li class="right" style="margin-right: 10px">
-          <a href="../genindex.html" title="General Index"
-             accesskey="I">index</a></li>
-        <li class="right" >
-          <a href="cursors.html" title="pygame.cursors"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="cdrom.html" title="pygame.cdrom"
-             accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">Pygame v1.9.2 documentation</a> &raquo;</li>
-    <script type="text/javascript" src="jquery.plugin.docscomments.js"></script>
-
-      </ul>
-    </div>
-    <div class="footer">
-        &copy; Copyright 2011, Pygame Developers.
-    </div>
-  </body>
-</html>

File docs/ref/cursors.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>pygame.cursors &mdash; Pygame v1.9.2 documentation</title>
-    <link rel="stylesheet" href="../_static/pygame.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '1.9.2',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="shortcut icon" href="../_static/pygame.ico"/>
-    <link rel="top" title="Pygame v1.9.2 documentation" href="../index.html" />
-    <link rel="next" title="pygame.display" href="display.html" />
-    <link rel="prev" title="pygame.Color" href="color.html" /> 
-  </head>
-  <body>  
-
-    <div class="document">
-
-  <div class="header">
-    <table>
-      <tr>
-	<td class="logo">
-	  <a href="http://www.pygame.org/">
-	    <img src="../_static/pygame_tiny.png"/>
-	  </a>
-	  <h5>pygame documentation</h5>
-	</td>
-	<td class="pagelinks">
-	  <p class="top">
-	    ||
-	    <a href="http://www.pygame.org/">Pygame Home</a> ||
-	    <a href="../index.html">Help Contents</a> ||
-	    <a href="../genindex.html">Reference Index</a> ||
-	  </p>
-	  <p class="bottom">
-	    <a href="camera.html">camera</a> || 
-	    <a href="cdrom.html">cdrom</a> || 
-	    <a href="color.html">Color</a> || 
-	    <a href="cursors.html">cursors</a> || 
-	    <a href="display.html">display</a> || 
-	    <a href="draw.html">draw</a> || 
-	    <a href="event.html">event</a> || 
-	    <a href="examples.html">examples</a> || 
-	    <a href="font.html">font</a> || 
-	    <a href="freetype.html">freetype</a> || 
-	    <a href="gfxdraw.html">gfxdraw</a> || 
-	    <a href="image.html">image</a> || 
-	    <a href="joystick.html">joystick</a> || 
-	    <a href="key.html">key</a> || 
-	    <a href="locals.html">locals</a> || 
-	    <a href="mask.html">mask</a> || 
-	    <a href="math.html">math</a> || 
-	    <a href="midi.html">midi</a> || 
-	    <a href="mixer.html">mixer</a> || 
-	    <a href="mouse.html">mouse</a> || 
-	    <a href="movie.html">movie</a> || 
-	    <a href="music.html">music</a> || 
-	    <a href="overlay.html">Overlay</a> || 
-	    <a href="pixelarray.html">PixelArray</a> || 
-	    <a href="pixelcopy.html">pixelcopy</a> || 
-	    <a href="pygame.html">pygame</a> || 
-	    <a href="rect.html">Rect</a> || 
-	    <a href="scrap.html">scrap</a> || 
-	    <a href="sndarray.html">sndarray</a> || 
-	    <a href="sprite.html">sprite</a> || 
-	    <a href="surface.html">Surface</a> || 
-	    <a href="surfarray.html">surfarray</a> || 
-	    <a href="tests.html">tests</a> || 
-	    <a href="time.html">time</a> || 
-	    <a href="transform.html">transform</a> || 
-	    <a href="pygame.html#module-pygame.version">version</a>
-	  </p>
-	</td>
-      </tr>
-    </table>
-  </div>
-
-      <div class="documentwrapper">
-          <div class="body">
-            
-  <div class="sectionwrapper">
-<div class="section" id="module-pygame.cursors">
-<span id="pygame-cursors"></span><dl class="definition module">
-<dt class="title module">
-<tt class="docutils literal"><span class="pre">pygame.cursors</span></tt></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">pygame module for cursor resources</span></div>
-</div>
-<table border="1" class="toc docutils">
-<colgroup>
-<col width="31%" />
-<col width="1%" />
-<col width="68%" />
-</colgroup>
-<tbody valign="top">
-<tr><td><a class="toc reference external" href="cursors.html#pygame.cursors.compile">pygame.cursors.compile</a></td>
-<td>—</td>
-<td>create binary cursor data from simple strings</td>
-</tr>
-<tr><td><a class="toc reference external" href="cursors.html#pygame.cursors.load_xbm">pygame.cursors.load_xbm</a></td>
-<td>—</td>
-<td>load cursor data from an xbm file</td>
-</tr>
-</tbody>
-</table>
-<p>Pygame offers control over the system hardware cursor. Pygame only supports
-black and white cursors for the system. You control the cursor with functions
-inside <a class="tooltip reference internal" href="mouse.html#module-pygame.mouse" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.mouse</span></tt><span class="tooltip-content">pygame module to work with the mouse</span></a>.</p>
-<p>This cursors module contains functions for loading and unencoding various
-cursor formats. These allow you to easily store your cursors in external files
-or directly as encoded python strings.</p>
-<p>The module includes several standard cursors. The <tt class="docutils literal"><span class="pre">pygame.mouse.set_cursor()</span></tt>
-function takes several arguments. All those arguments have been stored in a
-single tuple you can call like this:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">pygame</span><span class="o">.</span><span class="n">mouse</span><span class="o">.</span><span class="n">set_cursor</span><span class="p">(</span><span class="o">*</span><span class="n">pygame</span><span class="o">.</span><span class="n">cursors</span><span class="o">.</span><span class="n">arrow</span><span class="p">)</span>
-</pre></div>
-</div>
-<p>This module also contains a few cursors as formatted strings. You&#8217;ll need to
-pass these to <tt class="docutils literal"><span class="pre">pygame.cursors.compile()</span></tt> function before you can use them.
-The example call would look like this:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">cursor</span> <span class="o">=</span> <span class="n">pygame</span><span class="o">.</span><span class="n">cursors</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">pygame</span><span class="o">.</span><span class="n">cursors</span><span class="o">.</span><span class="n">textmarker_strings</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">pygame</span><span class="o">.</span><span class="n">mouse</span><span class="o">.</span><span class="n">set_cursor</span><span class="p">(</span><span class="o">*</span><span class="n">cursor</span><span class="p">)</span>
-</pre></div>
-</div>
-<p>The following variables are cursor bitmaps that can be used as cursor:</p>
-<blockquote>
-<ul class="simple">
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.arrow</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.diamond</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.broken_x</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.tri_left</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.tri_right</span></tt></li>
-</ul>
-</blockquote>
-<p>The following strings can be converted into cursor bitmaps with
-<tt class="docutils literal"><span class="pre">pygame.cursors.compile()</span></tt> :</p>
-<blockquote>
-<ul class="simple">
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.thickarrow_strings</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.sizer_x_strings</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.sizer_y_strings</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">pygame.cursors.sizer_xy_strings</span></tt></li>
-</ul>
-</blockquote>
-<dl class="definition function">
-<dt class="title" id="pygame.cursors.compile">
-<tt class="descclassname">pygame.cursors.</tt><tt class="descname">compile</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cursors.compile" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">create binary cursor data from simple strings</span></div>
-<div class="line"><span class="signature">compile(strings, black=&#8217;X&#8217;, white=&#8217;.&#8217;, xor=&#8217;o&#8217;) -&gt; data, mask</span></div>
-</div>
-<p>A sequence of strings can be used to create binary cursor data for the
-system cursor. The return values are the same format needed by
-<tt class="docutils literal"><span class="pre">pygame.mouse.set_cursor()</span></tt>.</p>
-<p>If you are creating your own cursor strings, you can use any value represent
-the black and white pixels. Some system allow you to set a special toggle
-color for the system color, this is also called the xor color. If the system
-does not support xor cursors, that color will simply be black.</p>
-<p>The width of the strings must all be equal and be divisible by 8. An example
-set of cursor strings looks like this</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">thickarrow_strings</span> <span class="o">=</span> <span class="p">(</span>               <span class="c">#sized 24x24</span>
-  <span class="s">&quot;XX                      &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XXX                     &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XXXX                    &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX.XX                   &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX..XX                  &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX...XX                 &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX....XX                &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX.....XX               &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX......XX              &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX.......XX             &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX........XX            &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX........XXX           &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX......XXXXX           &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX.XXX..XX              &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XXXX XX..XX             &quot;</span><span class="p">,</span>
-  <span class="s">&quot;XX   XX..XX             &quot;</span><span class="p">,</span>
-  <span class="s">&quot;     XX..XX             &quot;</span><span class="p">,</span>
-  <span class="s">&quot;      XX..XX            &quot;</span><span class="p">,</span>
-  <span class="s">&quot;      XX..XX            &quot;</span><span class="p">,</span>
-  <span class="s">&quot;       XXXX             &quot;</span><span class="p">,</span>
-  <span class="s">&quot;       XX               &quot;</span><span class="p">,</span>
-  <span class="s">&quot;                        &quot;</span><span class="p">,</span>
-  <span class="s">&quot;                        &quot;</span><span class="p">,</span>
-  <span class="s">&quot;                        &quot;</span><span class="p">)</span>
-</pre></div>
-</div>
-</dd></dl>
-
-<dl class="definition function">
-<dt class="title" id="pygame.cursors.load_xbm">
-<tt class="descclassname">pygame.cursors.</tt><tt class="descname">load_xbm</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.cursors.load_xbm" title="Permalink to this definition">¶</a></dt>
-<dd><div class="line-block">
-<div class="line"><span class="summaryline">load cursor data from an xbm file</span></div>
-<div class="line"><span class="signature">load_xbm(cursorfile) -&gt; cursor_args</span></div>
-<div class="line"><span class="signature">load_xbm(cursorfile, maskfile) -&gt; cursor_args</span></div>
-</div>
-<p>This loads cursors for a simple subset of <tt class="docutils literal"><span class="pre">XBM</span></tt> files. <tt class="docutils literal"><span class="pre">XBM</span></tt> files are
-traditionally used to store cursors on unix systems, they are an ascii
-format used to represent simple images.</p>
-<p>Sometimes the black and white color values will be split into two separate
-<tt class="docutils literal"><span class="pre">XBM</span></tt> files. You can pass a second maskfile argument to load the two
-images into a single cursor.</p>
-<p>The cursorfile and maskfile arguments can either be filenames or filelike
-object with the readlines method.</p>
-<p>The return value cursor_args can be passed directly to the
-<tt class="docutils literal"><span class="pre">pygame.mouse.set_cursor()</span></tt> function.</p>
-</dd></dl>
-
-</dd></dl>
-
-</div>
-
-  </div>
-          </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related">
-      <h3>Navigation</h3>
-      <ul>
-        <li class="right" style="margin-right: 10px">
-          <a href="../genindex.html" title="General Index"
-             accesskey="I">index</a></li>
-        <li class="right" >
-          <a href="display.html" title="pygame.display"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="color.html" title="pygame.Color"
-             accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">Pygame v1.9.2 documentation</a> &raquo;</li>
-    <script type="text/javascript" src="jquery.plugin.docscomments.js"></script>
-
-      </ul>
-    </div>
-    <div class="footer">
-        &copy; Copyright 2011, Pygame Developers.
-    </div>
-  </body>
-</html>

File docs/ref/display.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>pygame.display &mdash; Pygame v1.9.2 documentation</title>
-    <link rel="stylesheet" href="../_static/pygame.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '1.9.2',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="shortcut icon" href="../_static/pygame.ico"/>
-    <link rel="top" title="Pygame v1.9.2 documentation" href="../index.html" />
-    <link rel="next" title="pygame.draw" href="draw.html" />
-    <link rel="prev" title="pygame.cursors" href="cursors.html" /> 
-  </head>
-  <body>  
-
-    <div class="document">
-
-  <div class="header">
-    <table>
-      <tr>
-	<td class="logo">
-	  <a href="http://www.pygame.org/">
-	    <img src="../_static/pygame_tiny.png"/>
-	  </a>
-	  <h5>pygame documentation</h5>
-	</td>
-	<td class="pagelinks">
-	  <p class="top">
-	    ||
-	    <a href="http://www.pygame.org/">Pygame Home</a> ||
-	    <a href="../index.html">Help Contents</a> ||
-	    <a href="../genindex.html">Reference Index</a> ||
-	  </p>
-	  <p class="bottom">
-	    <a href="camera.html">camera</a> || 
-	    <a href="cdrom.html">cdrom</a> || 
-	    <a href="color.html">Color</a> || 
-	    <a href="cursors.html">cursors</a> || 
-	    <a href="display.html">display</a> || 
-	    <a href="draw.html">draw</a> || 
-	    <a href="event.html">event</a> || 
-	    <a href="examples.html">examples</a> || 
-	    <a href="font.html">font</a> || 
-	    <a href="freetype.html">freetype</a> || 
-	    <a href="gfxdraw.html">gfxdraw</a> || 
-	    <a href="image.html">image</a> || 
-	    <a h