Lenard Lindstrom avatar Lenard Lindstrom committed cf5b2c4

complete freetype docs (pygame changeset 46ed0161021c721dae9fbba82945b168374ded46)

Comments (0)

Files changed (3)

docs/pygame/genindex.html

   </dt>
 
       
+  <dt><a href="ref/examples.html#pygame.examples.freetype_misc.main">freetype_misc.main() (in module pygame.examples)</a>
+  </dt>
+
+      
   <dt><a href="ref/math.html#pygame.math.Vector2.from_polar">from_polar() (pygame.math.Vector2 method)</a>
   </dt>
 
   <dt><a href="ref/font.html#pygame.font.SysFont">SysFont() (in module pygame.font)</a>
   </dt>
 
+      <dd><dl>
+        
+  <dt><a href="ref/freetype.html#pygame.freetype.SysFont">(in module pygame.freetype)</a>
+  </dt>
+
+      </dl></dd>
   </dl></td>
 </tr></table>
 

docs/pygame/ref/examples.html

 <td>—</td>
 <td>run a font rendering example</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.vgrade.main">pygame.examples.vgrade.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.freetype_misc.main">pygame.examples.freetype_misc.main</a></td>
+<td>—</td>
+<td>run a freetype rendering example</td>
+</tr>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.vgrade.main">pygame.examples.vgrade.main</a></td>
 <td>—</td>
 <td>display a vertical gradient</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.eventlist.main">pygame.examples.eventlist.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.eventlist.main">pygame.examples.eventlist.main</a></td>
 <td>—</td>
 <td>display pygame events</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.arraydemo.main">pygame.examples.arraydemo.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.arraydemo.main">pygame.examples.arraydemo.main</a></td>
 <td>—</td>
 <td>show various surfarray effects</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.sound.main">pygame.examples.sound.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.sound.main">pygame.examples.sound.main</a></td>
 <td>—</td>
 <td>load and play a sound</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.sound_array_demos.main">pygame.examples.sound_array_demos.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.sound_array_demos.main">pygame.examples.sound_array_demos.main</a></td>
 <td>—</td>
 <td>play various sndarray effects</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.liquid.main">pygame.examples.liquid.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.liquid.main">pygame.examples.liquid.main</a></td>
 <td>—</td>
 <td>display an animated liquid effect</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.glcube.main">pygame.examples.glcube.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.glcube.main">pygame.examples.glcube.main</a></td>
 <td>—</td>
 <td>display an animated 3D cube using OpenGL</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.scrap_clipboard.main">pygame.examples.scrap_clipboard.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.scrap_clipboard.main">pygame.examples.scrap_clipboard.main</a></td>
 <td>—</td>
 <td>access the clipboard</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.mask.main">pygame.examples.mask.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.mask.main">pygame.examples.mask.main</a></td>
 <td>—</td>
 <td>display multiple images bounce off each other using collision detection</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.testsprite.main">pygame.examples.testsprite.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.testsprite.main">pygame.examples.testsprite.main</a></td>
 <td>—</td>
 <td>show lots of sprites moving around</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.headless_no_windows_needed.main">pygame.examples.headless_no_windows_needed.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.headless_no_windows_needed.main">pygame.examples.headless_no_windows_needed.main</a></td>
 <td>—</td>
 <td>write an image file that is smoothscaled copy of an input file</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.fastevents.main">pygame.examples.fastevents.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.fastevents.main">pygame.examples.fastevents.main</a></td>
 <td>—</td>
 <td>stress test the fastevents module</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.overlay.main">pygame.examples.overlay.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.overlay.main">pygame.examples.overlay.main</a></td>
 <td>—</td>
 <td>play a .pgm video using overlays</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.blend_fill.main">pygame.examples.blend_fill.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.blend_fill.main">pygame.examples.blend_fill.main</a></td>
 <td>—</td>
 <td>demonstrate the various surface.fill method blend options</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.blit_blends.main">pygame.examples.blit_blends.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.blit_blends.main">pygame.examples.blit_blends.main</a></td>
 <td>—</td>
 <td>uses alternative additive fill to that of surface.fill</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.cursors.main">pygame.examples.cursors.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.cursors.main">pygame.examples.cursors.main</a></td>
 <td>—</td>
 <td>display two different custom cursors</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.pixelarray.main">pygame.examples.pixelarray.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.pixelarray.main">pygame.examples.pixelarray.main</a></td>
 <td>—</td>
 <td>display various pixelarray generated effects</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.scaletest.main">pygame.examples.scaletest.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.scaletest.main">pygame.examples.scaletest.main</a></td>
 <td>—</td>
 <td>interactively scale an image using smoothscale</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.midi.main">pygame.examples.midi.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.midi.main">pygame.examples.midi.main</a></td>
 <td>—</td>
 <td>run a midi example</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.scroll.main">pygame.examples.scroll.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.scroll.main">pygame.examples.scroll.main</a></td>
 <td>—</td>
 <td>run a Surface.scroll example that shows a magnified image</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.movieplayer.main">pygame.examples.movieplayer.main</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.movieplayer.main">pygame.examples.movieplayer.main</a></td>
 <td>—</td>
 <td>play an MPEG movie</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="examples.html#pygame.examples.camera.main">pygame.examples.camera.main</a></td>
+<tr class="row-odd"><td><a class="toc reference external" href="examples.html#pygame.examples.camera.main">pygame.examples.camera.main</a></td>
 <td>—</td>
 <td>display video captured live from an attached camera</td>
 </tr>
 </dd></dl>
 
 <dl class="definition function">
+<dt class="title" id="pygame.examples.freetype_misc.main">
+<tt class="descclassname">freetype_misc.</tt><tt class="descname">main</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.examples.freetype_misc.main" title="Permalink to this definition">¶</a></dt>
+<dd><div class="line-block">
+<div class="line"><span class="summaryline">run a freetype rendering example</span></div>
+<div class="line"><span class="signature">freetype_misc.main() -&gt; None</span></div>
+</div>
+<p>A showcase of rendering features the <a class="tooltip reference internal" href="freetype.html#pygame.freetype.Font" title=""><tt class="xref py py-class docutils literal"><span class="pre">pygame.freetype.Font</span></tt><span class="tooltip-content">Create a new Font instance from a supported font file.</span></a>
+class provides in addition to those available with <a class="tooltip reference internal" href="font.html#pygame.font.Font" title=""><tt class="xref py py-class docutils literal"><span class="pre">pygame.font.Font</span></tt><span class="tooltip-content">create a new Font object from a file</span></a>.
+It is a demonstration of direct to surface rendering, with vertical text
+and rotated text, opaque text and semi transparent text, horizontally
+stretched text and vertically stretched text.</p>
+</dd></dl>
+
+<dl class="definition function">
 <dt class="title" id="pygame.examples.vgrade.main">
 <tt class="descclassname">vgrade.</tt><tt class="descname">main</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.examples.vgrade.main" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">

docs/pygame/ref/freetype.html

 <tbody valign="top">
 <tr class="row-odd"><td><a class="toc reference external" href="freetype.html#pygame.freetype.get_error">pygame.freetype.get_error</a></td>
 <td>—</td>
-<td>Return the latest FreeType2 error</td>
+<td>Return the latest FreeType error</td>
 </tr>
 <tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.get_version">pygame.freetype.get_version</a></td>
 <td>—</td>
-<td>Return the FreeType 2 version</td>
+<td>Return the FreeType version</td>
 </tr>
 <tr class="row-odd"><td><a class="toc reference external" href="freetype.html#pygame.freetype.init">pygame.freetype.init</a></td>
 <td>—</td>
-<td>Initialize the underlying FreeType 2 library.</td>
+<td>Initialize the underlying FreeType library.</td>
 </tr>
 <tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.quit">pygame.freetype.quit</a></td>
 <td>—</td>
-<td>Shut down the underlying FreeType 2 library.</td>
+<td>Shut down the underlying FreeType library.</td>
 </tr>
 <tr class="row-odd"><td><a class="toc reference external" href="freetype.html#pygame.freetype.was_init">pygame.freetype.was_init</a></td>
 <td>—</td>
-<td>Return whether the the FreeType 2 library is initialized.</td>
+<td>Return whether the the FreeType library is initialized.</td>
 </tr>
 <tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.get_default_resolution">pygame.freetype.get_default_resolution</a></td>
 <td>—</td>
 <td>—</td>
 <td>Set the default pixel size in dots per inch for the module</td>
 </tr>
-<tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.get_default_font">pygame.freetype.get_default_font</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.SysFont">pygame.freetype.SysFont</a></td>
+<td>—</td>
+<td>create a Font object from the system fonts</td>
+</tr>
+<tr class="row-odd"><td><a class="toc reference external" href="freetype.html#pygame.freetype.get_default_font">pygame.freetype.get_default_font</a></td>
 <td>—</td>
 <td>Get the filename of the default font</td>
 </tr>
-<tr class="row-odd"><td><a class="toc reference external" href="freetype.html#pygame.freetype.Font">pygame.freetype.Font</a></td>
+<tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.Font">pygame.freetype.Font</a></td>
 <td>—</td>
 <td>Create a new Font instance from a supported font file.</td>
 </tr>
 </tbody>
 </table>
-<p>The <a class="tooltip reference internal" href="#module-pygame.freetype" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.freetype</span></tt><span class="tooltip-content">Enhanced Pygame module for loading and rendering computer fonts</span></a> module allows for the rendering of all font file formats
-supported by FreeType, namely <tt class="docutils literal"><span class="pre">TTF</span></tt>, Type1, <tt class="docutils literal"><span class="pre">CFF</span></tt>, OpenType, <tt class="docutils literal"><span class="pre">SFNT</span></tt>, <tt class="docutils literal"><span class="pre">PCF</span></tt>,
-<tt class="docutils literal"><span class="pre">FNT</span></tt>, <tt class="docutils literal"><span class="pre">BDF</span></tt>, <tt class="docutils literal"><span class="pre">PFR</span></tt> and Type42 fonts. It can render any UTF-32 character in a
-font file.</p>
-<p>This module is a replacement for <a class="tooltip reference internal" href="font.html#module-pygame.font" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.font</span></tt><span class="tooltip-content">pygame module for loading and rendering fonts</span></a>. It has all of the functionality
-of the original, plus many new features. Yet is has absolutely no dependencies
-on the SDL_ttf library. The <a class="tooltip reference internal" href="#module-pygame.freetype" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.freetype</span></tt><span class="tooltip-content">Enhanced Pygame module for loading and rendering computer fonts</span></a> module is not itself backward
-compatible with <a class="tooltip reference internal" href="font.html#module-pygame.font" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.font</span></tt><span class="tooltip-content">pygame module for loading and rendering fonts</span></a>. Instead, a new <tt class="xref py py-mod docutils literal"><span class="pre">pygame.ftfont</span></tt> provides
-a drop-in replacement for <a class="tooltip reference internal" href="font.html#module-pygame.font" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.font</span></tt><span class="tooltip-content">pygame module for loading and rendering fonts</span></a>.</p>
-<p>Most of the work done with fonts is done by using the actual Font objects. The
-module by itself only has routines to initialize itself and create Font objects
-with <tt class="docutils literal"><span class="pre">pygame.freetype.Font()</span></tt>.</p>
-<p>You can load fonts from the system by using the <tt class="docutils literal"><span class="pre">pygame.freetype.SysFont()</span></tt>
-function. There are a few other functions to help find system fonts.</p>
-<p>For now undefined character codes are replaced with the <tt class="docutils literal"><span class="pre">undefined</span> <span class="pre">character</span></tt>.
+<p>The <a class="tooltip reference internal" href="#module-pygame.freetype" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.freetype</span></tt><span class="tooltip-content">Enhanced Pygame module for loading and rendering computer fonts</span></a> module is a replacement for <a class="tooltip reference internal" href="font.html#module-pygame.font" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.font</span></tt><span class="tooltip-content">pygame module for loading and rendering fonts</span></a>.
+It has all of the functionality of the original, plus many new features.
+Yet is has absolutely no dependencies on the SDL_ttf library.
+It is implemented directly on the FreeType 2 library.
+The <a class="tooltip reference internal" href="#module-pygame.freetype" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.freetype</span></tt><span class="tooltip-content">Enhanced Pygame module for loading and rendering computer fonts</span></a> module is not itself backward compatible with
+<a class="tooltip reference internal" href="font.html#module-pygame.font" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.font</span></tt><span class="tooltip-content">pygame module for loading and rendering fonts</span></a>.
+Instead, use the <tt class="xref py py-mod docutils literal"><span class="pre">pygame.ftfont</span></tt> module as a drop-in replacement
+for <a class="tooltip reference internal" href="font.html#module-pygame.font" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.font</span></tt><span class="tooltip-content">pygame module for loading and rendering fonts</span></a>.</p>
+<p>All font file formats supported by FreeType can be rendered by
+<a class="tooltip reference internal" href="#module-pygame.freetype" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.freetype</span></tt><span class="tooltip-content">Enhanced Pygame module for loading and rendering computer fonts</span></a>, namely <tt class="docutils literal"><span class="pre">TTF</span></tt>, Type1, <tt class="docutils literal"><span class="pre">CFF</span></tt>, OpenType,
+<tt class="docutils literal"><span class="pre">SFNT</span></tt>, <tt class="docutils literal"><span class="pre">PCF</span></tt>, <tt class="docutils literal"><span class="pre">FNT</span></tt>, <tt class="docutils literal"><span class="pre">BDF</span></tt>, <tt class="docutils literal"><span class="pre">PFR</span></tt> and Type42 fonts.
+All glyphs having UTF-32 code points are accessible (see <tt class="xref py py-attr docutils literal"><span class="pre">ucs4</span></tt>).</p>
+<p>Most work on fonts is done using <a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a> instances.
+The module itself only has routines for initialization and creation
+of <a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a> objects.
+You can load fonts from the system using the <a class="reference internal" href="#pygame.freetype.SysFont" title="pygame.freetype.SysFont"><tt class="xref py py-func docutils literal"><span class="pre">SysFont()</span></tt></a> function.</p>
+<p>Extra support of bitmap fonts is available. Available bitmap sizes can
+be listed (see <a class="reference internal" href="#pygame.freetype.Font.get_sizes" title="pygame.freetype.Font.get_sizes"><tt class="xref py py-meth docutils literal"><span class="pre">Font.get_sizes()</span></tt></a>). For bitmap only fonts <a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a>
+can set the size for you
+(see the <a class="reference internal" href="#freetype-font-size-argument"><em>Font class size argument</em></a>).</p>
+<p>For now undefined character codes are replaced with the <tt class="docutils literal"><span class="pre">.notdef</span></tt>
+(not defined) character.
 How undefined codes are handled may become configurable in a future release.</p>
 <p>Pygame comes with a builtin default font. This can always be accessed by
-passing None as the font name to the Font constructor.</p>
-<p>New in Pygame 1.9.2</p>
+passing None as the font name to the <a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a> constructor.</p>
+<p>Extra rendering features available to <a class="tooltip reference internal" href="#pygame.freetype.Font" title=""><tt class="xref py py-class docutils literal"><span class="pre">pygame.freetype.Font</span></tt><span class="tooltip-content">Create a new Font instance from a supported font file.</span></a>
+are direct to surface rendering (see <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">Font.render_to()</span></tt></a>), character kerning
+(see <a class="reference internal" href="#pygame.freetype.Font.kerning" title="pygame.freetype.Font.kerning"><tt class="xref py py-attr docutils literal"><span class="pre">Font.kerning</span></tt></a>), vertical layout (see <a class="reference internal" href="#pygame.freetype.Font.vertical" title="pygame.freetype.Font.vertical"><tt class="xref py py-attr docutils literal"><span class="pre">Font.vertical</span></tt></a>),
+rotation of rendered text (see <tt class="xref py py-attr docutils literal"><span class="pre">rotation</span></tt>), and the strong style
+(see <a class="reference internal" href="#pygame.freetype.Font.strong" title="pygame.freetype.Font.strong"><tt class="xref py py-attr docutils literal"><span class="pre">Font.strong</span></tt></a>). Some properties are configurable, such as
+strong style strength (see <a class="reference internal" href="#pygame.freetype.Font.strength" title="pygame.freetype.Font.strength"><tt class="xref py py-attr docutils literal"><span class="pre">Font.strength</span></tt></a>) and underline positioning
+(see <tt class="xref py py-attr docutils literal"><span class="pre">underline_adjustment</span></tt>). Text can be positioned by the upper
+right corner of the text box or by the text baseline (see <a class="reference internal" href="#pygame.freetype.Font.origin" title="pygame.freetype.Font.origin"><tt class="xref py py-attr docutils literal"><span class="pre">Font.origin</span></tt></a>).
+Finally, a font&#8217;s vertical and horizontal size can be adjusted separately
+(see <a class="reference internal" href="#pygame.freetype.Font.size" title="pygame.freetype.Font.size"><tt class="xref py py-attr docutils literal"><span class="pre">Font.size</span></tt></a>). The <tt class="xref py py-mod docutils literal"><span class="pre">pygame.examples.freetype</span></tt> example
+(<a class="tooltip reference internal" href="examples.html#pygame.examples.freetype_misc.main" title=""><tt class="xref py py-func docutils literal"><span class="pre">pygame.examples.freetype_misc.main()</span></tt><span class="tooltip-content">run a freetype rendering example</span></a>) shows these features in use.</p>
+<p>The Pygame package does not import <tt class="xref py py-mod docutils literal"><span class="pre">freetype</span></tt> automatically when
+loaded. This module must be imported explicitly to be used.</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">pygame</span>
+<span class="kn">import</span> <span class="nn">pygame.freetype</span>
+</pre></div>
+</div>
+<p>The <tt class="xref py py-mod docutils literal"><span class="pre">freetype</span></tt> module is new in Pygame 1.9.2</p>
 <dl class="definition function">
 <dt class="title" id="pygame.freetype.get_error">
 <tt class="descclassname">pygame.freetype.</tt><tt class="descname">get_error</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.freetype.get_error" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">
-<div class="line"><span class="summaryline">Return the latest FreeType2 error</span></div>
+<div class="line"><span class="summaryline">Return the latest FreeType error</span></div>
 <div class="line"><span class="signature">get_error() -&gt; str</span></div>
 </div>
 <p>Return a description of the last error which occurred in the FreeType2
 <dt class="title" id="pygame.freetype.get_version">
 <tt class="descclassname">pygame.freetype.</tt><tt class="descname">get_version</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.freetype.get_version" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">
-<div class="line"><span class="summaryline">Return the FreeType 2 version</span></div>
+<div class="line"><span class="summaryline">Return the FreeType version</span></div>
 <div class="line"><span class="signature">get_version() -&gt; (int, int, int)</span></div>
 </div>
-<p>Returns the version of the FreeType2 library which was used to build the
-&#8216;freetype&#8217; module.</p>
-<p>Note that the freetype module depends on the FreeType 2 library. It will
-not compile with the original FreeType 1.0. Hence, the first element of the
-tuple will always be &#8220;2&#8221;.</p>
+<p>Returns the version of the FreeType library in use by this module.</p>
+<p>Note that the <tt class="xref py py-mod docutils literal"><span class="pre">freetype</span></tt> module depends on the FreeType 2 library.
+It will not compile with the original FreeType 1.0. Hence, the first element
+of the tuple will always be &#8220;2&#8221;.</p>
 </dd></dl>
 
 <dl class="definition function">
 <dt class="title" id="pygame.freetype.init">
 <tt class="descclassname">pygame.freetype.</tt><tt class="descname">init</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.freetype.init" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">
-<div class="line"><span class="summaryline">Initialize the underlying FreeType 2 library.</span></div>
+<div class="line"><span class="summaryline">Initialize the underlying FreeType library.</span></div>
 <div class="line"><span class="signature">init(cache_size=64, resolution=72)</span></div>
 </div>
-<p>This function initializes the underlying FreeType 2 library and must be
-called before trying to use any of the functionality of the &#8216;freetype&#8217;
+<p>This function initializes the underlying FreeType library and must be
+called before trying to use any of the functionality of the <tt class="xref py py-mod docutils literal"><span class="pre">freetype</span></tt>
 module.</p>
-<p>However, this function will be automatically called by <tt class="docutils literal"><span class="pre">pygame.init()</span></tt>.
-It is safe to call this function more than once.</p>
-<p>Optionally, you may specify a default size for the Glyph cache: this is the
+<p>However, <a class="tooltip reference internal" href="pygame.html#pygame.init" title=""><tt class="xref py py-meth docutils literal"><span class="pre">pygame.init()</span></tt><span class="tooltip-content">initialize all imported pygame modules</span></a> will automatically call this function
+if the <tt class="xref py py-mod docutils literal"><span class="pre">freetype</span></tt> module is already imported. It is safe to call this
+function more than once.</p>
+<p>Optionally, you may specify a default <em>cache_size</em> for the Glyph cache: the
 maximum number of glyphs that will be cached at any given time by the
 module. Exceedingly small values will be automatically tuned for
-performance. Also a default pixel resolution, in dots per inch, can
+performance. Also a default pixel <em>resolution</em>, in dots per inch, can
 be given to adjust font scaling.</p>
 </dd></dl>
 
 <dt class="title" id="pygame.freetype.quit">
 <tt class="descclassname">pygame.freetype.</tt><tt class="descname">quit</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.freetype.quit" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">
-<div class="line"><span class="summaryline">Shut down the underlying FreeType 2 library.</span></div>
+<div class="line"><span class="summaryline">Shut down the underlying FreeType library.</span></div>
 <div class="line"><span class="signature">quit()</span></div>
 </div>
-<p>This function de-initializes the <tt class="docutils literal"><span class="pre">freetype</span></tt> module. After calling this
+<p>This function closes the <tt class="docutils literal"><span class="pre">freetype</span></tt> module. After calling this
 function, you should not invoke any class, method or function related to the
 <tt class="docutils literal"><span class="pre">freetype</span></tt> module as they are likely to fail or might give unpredictable
 results. It is safe to call this function even if the module hasn&#8217;t been
 <dt class="title" id="pygame.freetype.was_init">
 <tt class="descclassname">pygame.freetype.</tt><tt class="descname">was_init</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.freetype.was_init" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">
-<div class="line"><span class="summaryline">Return whether the the FreeType 2 library is initialized.</span></div>
+<div class="line"><span class="summaryline">Return whether the the FreeType library is initialized.</span></div>
 <div class="line"><span class="signature">was_init() -&gt; bool</span></div>
 </div>
-<p>Returns whether the the FreeType 2 library is initialized.</p>
+<p>Returns whether the the FreeType library is initialized.</p>
 </dd></dl>
 
 <dl class="definition function">
 <div class="line"><span class="summaryline">Return the default pixel size in dots per inch</span></div>
 <div class="line"><span class="signature">get_default_resolution() -&gt; long</span></div>
 </div>
-<p>Returns the default pixel size, in dots per inch for the module. If not changed
-it will be 72.</p>
+<p>Returns the default pixel size, in dots per inch, for the module.
+The default is 72dpi.</p>
 </dd></dl>
 
 <dl class="definition function">
 <div class="line"><span class="signature">set_default_resolution([resolution])</span></div>
 </div>
 <p>Set the default pixel size, in dots per inch, for the module. If the
-optional argument is omitted or zero the resolution is reset to 72.</p>
+optional argument is omitted or zero the resolution is reset to 72dpi.</p>
+</dd></dl>
+
+<dl class="definition function">
+<dt class="title" id="pygame.freetype.SysFont">
+<tt class="descclassname">pygame.freetype.</tt><tt class="descname">SysFont</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.freetype.SysFont" title="Permalink to this definition">¶</a></dt>
+<dd><div class="line-block">
+<div class="line"><span class="summaryline">create a Font object from the system fonts</span></div>
+<div class="line"><span class="signature">SysFont(name, size, bold=False, italic=False) -&gt; Font</span></div>
+</div>
+<p>Return a new Font object that is loaded from the system fonts. The font will
+match the requested <em>bold</em> and <em>italic</em> flags. If a suitable system font
+is not found the default, Pygame, is returned instead. The font <em>name</em>
+can be a comma separated list of font names to search for.</p>
 </dd></dl>
 
 <dl class="definition function">
 <div class="line"><span class="summaryline">Get the filename of the default font</span></div>
 <div class="line"><span class="signature">get_default_font() -&gt; string</span></div>
 </div>
-<p>Return the filename of the system font. This is not the full path to the
-file. This file can usually be found in the same directory as the font
-module, but it can also be bundled in separate archives.</p>
+<p>Return the filename of the default Pygame font. This is not the full path
+to the file. The file is usually in the same directory as the font module,
+but can also be bundled in a separate archive.</p>
 </dd></dl>
 
 <dl class="definition class">
 </tr>
 <tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.Font.fixed_sizes">pygame.freetype.Font.fixed_sizes</a></td>
 <td>—</td>
-<td>the number of embedded bitmap sizes the font</td>
+<td>the number of available bitmap sizes for the font</td>
 </tr>
 <tr class="row-odd"><td><a class="toc reference external" href="freetype.html#pygame.freetype.Font.scalable">pygame.freetype.Font.scalable</a></td>
 <td>—</td>
 </tr>
 <tr class="row-even"><td><a class="toc reference external" href="freetype.html#pygame.freetype.Font.use_bitmap_strikes">pygame.freetype.Font.use_bitmap_strikes</a></td>
 <td>—</td>
-<td>allow the use of embeddeded bitmaps in an outline font file</td>
+<td>allow the use of embedded bitmaps in an outline font file</td>
 </tr>
 <tr class="row-odd"><td><a class="toc reference external" href="freetype.html#pygame.freetype.Font.antialiased">pygame.freetype.Font.antialiased</a></td>
 <td>—</td>
 </tbody>
 </table>
 <p>Argument <em>file</em> can be either a string representing the font&#8217;s filename, a
-file-like object containing the font, or None; if None, the default, built-in font
-is used.</p>
-<p>Optionally, a <em>size</em> argument may be specified to set the default size in
-points, which will be used when rendering the font. The size can also be
-passed explicitly to each method call. Because of the way the caching
-system works, specifying a default size on the constructor doesn&#8217;t imply a
-performance gain over manually passing the size on each function call.
-If the font is bitmap and no <em>size</em> is given, the default size is set
-to the first available size for the font, if possible.</p>
+file-like object containing the font, or None; if None, the default,
+Pygame, font is used.</p>
+<p id="freetype-font-size-argument">Optionally, a <em>size</em> argument may be specified to set the default size in
+points, which determines the size of the rendered characters.
+The size can also be passed explicitly to each method call.
+Because of the way the caching   system works, specifying a default size on
+the constructor doesn&#8217;t imply a performance gain over manually passing
+the size on each function call. If the font is bitmap and no <em>size</em>
+is given, the default size is set to the first available size for the font.</p>
 <p>If the font file has more than one font, the font to load can be chosen with
 the <em>index</em> argument. An exception is raised for an out-of-range font index
 value.</p>
-<p>The optional resolution argument sets the pixel size, in dots per inch,
+<p>The optional <em>resolution</em> argument sets the pixel size, in dots per inch,
 for use in scaling glyphs for this Font instance. If 0 then the default
 module value, set by <tt class="xref py py-meth docutils literal"><span class="pre">freetype.init()</span></tt>, is used. The Font object&#8217;s
-resolution can only be changed by reinitializing the Font instance.</p>
-<p>The optional ucs4 argument, an integer, sets the default text translation
+resolution can only be changed by re-initializing the Font instance.</p>
+<p>The optional <em>ucs4</em> argument, an integer, sets the default text translation
 mode: 0 (False) recognize UTF-16 surrogate pairs, any other value (True),
 to treat Unicode text as UCS-4, with no surrogate pairs. See
 <a class="reference internal" href="#pygame.freetype.Font.ucs4" title="pygame.freetype.Font.ucs4"><tt class="xref py py-attr docutils literal"><span class="pre">Font.ucs4</span></tt></a>.</p>
 <div class="line"><span class="summaryline">Return the size and offset of rendered text</span></div>
 <div class="line"><span class="signature">get_rect(text, style=STYLE_DEFAULT, rotation=0, size=0) -&gt; rect</span></div>
 </div>
-<p>Gets the final dimensions and origin, in pixels, of &#8216;text&#8217; using the
-current point size, style, rotation and orientation. These are either
-taken from the arguments, if given, else from the default values set
-for the font object.</p>
-<p>Returns a rect containing the width and height of the text&#8217;s bounding
-box and the position of the text&#8217;s origin. The origin can be used
-to align separately rendered pieces of text. It gives the baseline
-position and bearing at the start of the text.</p>
-<p>If text is a char (byte) string, then its encoding is assumed to be
+<p>Gets the final dimensions and origin, in pixels, of <em>text</em> using the
+optional <em>size</em> in points, <em>style</em>, and <em>rotation</em>. For other
+relevant render properties, and for any optional argument not given,
+the default values set for the <a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a> instance are used.</p>
+<p>Returns a <tt class="xref py py-class docutils literal"><span class="pre">Rect</span></tt> instance containing the width and height
+of the text&#8217;s bounding box and the position of the text&#8217;s origin.
+The origin is useful in aligning separately rendered pieces of text.
+It gives the baseline position and bearing at the start of the text.
+See the <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a> method for an example.</p>
+<p>If <em>text</em> is a char (byte) string, its encoding is assumed to be
 <tt class="docutils literal"><span class="pre">LATIN1</span></tt>.</p>
-<p>Optionally, text can be <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt>, which will return the bounding
+<p>Optionally, <em>text</em> can be <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt>, which will return the bounding
 rectangle for the text passed to a previous <a class="reference internal" href="#pygame.freetype.Font.get_rect" title="pygame.freetype.Font.get_rect"><tt class="xref py py-meth docutils literal"><span class="pre">get_rect()</span></tt></a>,
 <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.render_raw" title="pygame.freetype.Font.render_raw"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw()</span></tt></a>, or
 <a class="reference internal" href="#pygame.freetype.Font.render_raw_to" title="pygame.freetype.Font.render_raw_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw_to()</span></tt></a> call. See <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a> for more
 <div class="line"><span class="summaryline">Return the glyph metrics for the given text</span></div>
 <div class="line"><span class="signature">get_metrics(text, size=0) -&gt; [(...), ...]</span></div>
 </div>
-<p>Returns the glyph metrics for each character in &#8216;text&#8217;.</p>
-<p>The glyph metrics are returned inside a list; each character will be
-represented as a tuple inside the list with the following values:</p>
+<p>Returns the glyph metrics for each character in <em>text</em>.</p>
+<p>The glyph metrics are returned as a list of tuples. Each tuple gives
+metrics of a single character glyph. The glyph metrics are:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="p">(</span><span class="n">min_x</span><span class="p">,</span> <span class="n">max_x</span><span class="p">,</span> <span class="n">min_y</span><span class="p">,</span> <span class="n">max_y</span><span class="p">,</span> <span class="n">horizontal_advance_x</span><span class="p">,</span> <span class="n">horizontal_advance_y</span><span class="p">)</span>
 </pre></div>
 </div>
 grid-fitted pixel coordinates of type int. The advance values are
 float values.</p>
 <p>The calculations are done using the font&#8217;s default size in points.
-Optionally you may specify another point size to use.</p>
+Optionally you may specify another point size with the <em>size</em> argument.</p>
 <p>The metrics are adjusted for the current rotation, strong, and oblique
 settings.</p>
 <p>If text is a char (byte) string, then its encoding is assumed to be
 <div class="line"><span class="summaryline">The scaled height of the font in pixels</span></div>
 <div class="line"><span class="signature">get_sized_height(&lt;size&gt;=0) -&gt; int</span></div>
 </div>
-<p>Read only. Gets the height of the font. This is the average value of all
+<p>Returns the height of the font. This is the average value of all
 glyphs in the font. It is not adjusted for strong or rotation.</p>
 </dd></dl>
 
 <div class="line"><span class="signature">get_sizes() -&gt; [(int, int, int, float, float), ...]</span></div>
 <div class="line"><span class="signature">get_sizes() -&gt; []</span></div>
 </div>
-<p>This returns a list of tuple records, one for each point size
+<p>Returns a list of tuple records, one for each point size
 supported. Each tuple containing the point size, the height in pixels,
 width in pixels, horizontal ppem (nominal width) in fractional pixels,
 and vertical ppem (nominal height) in fractional pixels.</p>
 <div class="line"><span class="summaryline">Return rendered text as a surface</span></div>
 <div class="line"><span class="signature">render(text, fgcolor=None, bgcolor=None, style=STYLE_DEFAULT, rotation=0, size=0) -&gt; (Surface, Rect)</span></div>
 </div>
-<p>Returns a new <a class="tooltip reference internal" href="surface.html#pygame.Surface" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.Surface</span></tt><span class="tooltip-content">pygame object for representing images</span></a>, with the text rendered to it
+<p>Returns a new <tt class="xref py py-mod docutils literal"><span class="pre">Surface</span></tt>, with the text rendered to it
 in the color given by &#8216;fgcolor&#8217;. If no foreground color is given,
 the default foreground color, <a class="reference internal" href="#pygame.freetype.Font.fgcolor" title="pygame.freetype.Font.fgcolor"><tt class="xref py py-attr docutils literal"><span class="pre">fgcolor</span></tt></a> is used.
 If <tt class="docutils literal"><span class="pre">bgcolor</span></tt> is given, the surface
-will be filled with this color. If no background color is given,
-the surface is filled with zero alpha opacity. Normally the returned
+will be filled with this color. When no background color is given,
+the surface background is transparent, zero alpha. Normally the returned
 surface has a 32 bit pixel size. However, if <tt class="docutils literal"><span class="pre">bgcolor</span></tt> is <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt>
-and anti-aliasing is disabled a two color 8 bit surface with colorkey
-set for the background color is returned.</p>
+and anti-aliasing is disabled a monochrome 8 bit colorkey surface,
+with colorkey set for the background color, is returned.</p>
 <p>The return value is a tuple: the new surface and the bounding
 rectangle giving the size and origin of the rendered text.</p>
 <p>If an empty string is passed for text then the returned Rect is zero
-width and the height of the font. If dest is <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> the returned
-surface is the same dimensions as the boundary rect.
-The rect will test False.</p>
-<p>The rendering is done using the font&#8217;s default size in points and its
-default style, without any rotation, and taking into account fonts which
-are set to be drawn vertically via the <a class="reference internal" href="#pygame.freetype.Font.vertical" title="pygame.freetype.Font.vertical"><tt class="xref py py-attr docutils literal"><span class="pre">vertical</span></tt></a> attribute.
-Optionally you may specify another point size to use via the &#8216;size&#8217;
-argument, a text rotation via the &#8216;rotation&#8217; argument, or a new text
-style via the &#8216;style&#8217; argument. See the attr <a class="reference internal" href="#pygame.freetype.Font.size" title="pygame.freetype.Font.size"><tt class="xref py py-attr docutils literal"><span class="pre">size</span></tt></a>,
-<a class="reference internal" href="#pygame.freetype.Font.rotation" title="pygame.freetype.Font.rotation"><tt class="xref py py-attr docutils literal"><span class="pre">rotation</span></tt></a>, and <a class="reference internal" href="#pygame.freetype.Font.style" title="pygame.freetype.Font.style"><tt class="xref py py-attr docutils literal"><span class="pre">style</span></tt></a> attributes.</p>
-<p>If text is a char (byte) string, then its encoding is assumed to be
+width and the height of the font.</p>
+<p>Optional <em>fgcolor</em>, <em>style</em>, <em>rotation</em>, and <em>size</em> arguments override
+the default values set for the <a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a> instance.</p>
+<p>If <em>text</em> is a char (byte) string, then its encoding is assumed to be
 <tt class="docutils literal"><span class="pre">LATIN1</span></tt>.</p>
-<p>Optionally, text can be None, which will return the bounding
-rectangle for the text passed to a previous <a class="reference internal" href="#pygame.freetype.Font.get_rect" title="pygame.freetype.Font.get_rect"><tt class="xref py py-meth docutils literal"><span class="pre">get_rect()</span></tt></a>,
-<a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.render_raw" title="pygame.freetype.Font.render_raw"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw()</span></tt></a>, or
-<a class="reference internal" href="#pygame.freetype.Font.render_raw_to" title="pygame.freetype.Font.render_raw_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw_to()</span></tt></a> call. See <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a> for more
-details.</p>
+<p>Optionally, <em>text</em> can be <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt>, which will render the text
+passed to a previous <a class="reference internal" href="#pygame.freetype.Font.get_rect" title="pygame.freetype.Font.get_rect"><tt class="xref py py-meth docutils literal"><span class="pre">get_rect()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a>,
+<a class="reference internal" href="#pygame.freetype.Font.render_raw" title="pygame.freetype.Font.render_raw"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw()</span></tt></a>, or <a class="reference internal" href="#pygame.freetype.Font.render_raw_to" title="pygame.freetype.Font.render_raw_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw_to()</span></tt></a> call.
+See <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a> for details.</p>
 </dd></dl>
 
 <dl class="definition method">
 <div class="line"><span class="summaryline">Render text onto an existing surface</span></div>
 <div class="line"><span class="signature">render_to(surf, dest, text, fgcolor=None, bgcolor=None, style=STYLE_DEFAULT, rotation=0, size=0) -&gt; Rect</span></div>
 </div>
-<p>Renders the string &#8216;text&#8217; to a <a class="tooltip reference internal" href="surface.html#pygame.Surface" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.Surface</span></tt><span class="tooltip-content">pygame object for representing images</span></a> &#8216;surf&#8217;,
-using the color &#8216;fgcolor&#8217;, if given, or the default foreground
-color, <a class="reference internal" href="#pygame.freetype.Font.fgcolor" title="pygame.freetype.Font.fgcolor"><tt class="xref py py-attr docutils literal"><span class="pre">fgcolor</span></tt></a>, otherwise.</p>
-<p>Argument &#8216;dest&#8217; is an (x, y) surface coordinate pair. If either x
-or y is not an integer it is converted to one if possible.
-Any sequence, including <tt class="xref py py-class docutils literal"><span class="pre">Rect</span></tt>, for which the first
-two elements are positions x and y is accepted.</p>
-<p>If a background color is given, the surface is first filled with that
-color. The text is blitted next. Both the background fill and text
-rendering involve full alpha blits. That is, the alpha values of
-both the foreground and background colors, as well as those of the
-destination surface if it has per-pixel alpha.</p>
+<p>Renders the string <em>text</em> to the <a class="tooltip reference internal" href="surface.html#pygame.Surface" title=""><tt class="xref py py-mod docutils literal"><span class="pre">pygame.Surface</span></tt><span class="tooltip-content">pygame object for representing images</span></a> <em>surf</em>,
+at position <em>dest</em>, a (x, y) surface coordinate pair.
+If either x or y is not an integer it is converted to one if possible.
+Any sequence where the first two items are x and y positional elements
+is accepted, including a <tt class="xref py py-class docutils literal"><span class="pre">Rect</span></tt> instance.  As with <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a>,
+optional <em>fgcolor</em>, <em>style</em>, <em>rotation</em>, and <em>size</em> argument are
+available.</p>
+<p>If a background color <em>bgcolor</em> is given, the text bounding box is
+first filled with that color. The text is blitted next.
+Both the background fill and text rendering involve full alpha blits.
+That is, the alpha values of the foreground, background, and destination
+target surface all affect the blit.</p>
 <p>The return value is a rectangle giving the size and position of the
 rendered text within the surface.</p>
 <p>If an empty string is passed for text then the returned <tt class="xref py py-class docutils literal"><span class="pre">Rect</span></tt>
 is zero width and the height of the font. The rect will test False.</p>
-<p>Optionally, text can be set <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt>, which will re-render text
+<p>Optionally, <em>text</em> can be set <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt>, which will re-render text
 passed to a previous <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.get_rect" title="pygame.freetype.Font.get_rect"><tt class="xref py py-meth docutils literal"><span class="pre">get_rect()</span></tt></a>, <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a>,
 <a class="reference internal" href="#pygame.freetype.Font.render_raw" title="pygame.freetype.Font.render_raw"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw()</span></tt></a>, or <a class="reference internal" href="#pygame.freetype.Font.render_raw_to" title="pygame.freetype.Font.render_raw_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_raw_to()</span></tt></a> call. Primarily, this
 feature is an aid to using <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a> in combination with
 Otherwise, <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a> will recalculate the layout if called
 with a text string or one of the above properties has changed
 after the <a class="reference internal" href="#pygame.freetype.Font.get_rect" title="pygame.freetype.Font.get_rect"><tt class="xref py py-meth docutils literal"><span class="pre">get_rect()</span></tt></a> call.</p>
-<p>By default, the point size and style set for the font are used
-if not passed as arguments. The text is unrotated unless a non-zero
-rotation value is given.</p>
-<p>If text is a char (byte) string, then its encoding is assumed to be
+<p>If <em>text</em> is a char (byte) string, then its encoding is assumed to be
 <tt class="docutils literal"><span class="pre">LATIN1</span></tt>.</p>
 </dd></dl>
 
 <div class="line"><span class="summaryline">Return rendered text as a string of bytes</span></div>
 <div class="line"><span class="signature">render_raw(text, style=STYLE_DEFAULT, rotation=0, size=0, invert=False) -&gt; (bytes, (int, int))</span></div>
 </div>
-<p>Like <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a> but the tuple returned is an 8 bit
-monochrome string of bytes and its size. The foreground color is 255, the
+<p>Like <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a> but with the pixels returned as a byte string
+of 8-bit gray-scale values. The foreground color is 255, the
 background 0, useful as an alpha mask for a foreground pattern.</p>
 </dd></dl>
 
 <div class="line"><span class="signature">render_raw_to(array, text, dest=None, style=STYLE_DEFAULT, rotation=0, size=0, invert=False) -&gt; (int, int)</span></div>
 </div>
 <p>Render to an array object exposing an array struct interface. The array
-must be two dimensional with integer items. The default dest value, None,
-is equivalent to (0, 0). See <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a>.</p>
+must be two dimensional with integer items. The default <em>dest</em> value,
+<tt class="xref py py-const docutils literal"><span class="pre">None</span></tt>, is equivalent to position (0, 0). See <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a>.
+As with the other render methods, <em>text</em> can be <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> to
+render a text string passed previously to another method.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 </div>
 <p>Gets or sets the default style of the Font. This default style will be
 used for all text rendering and size calculations unless overridden
-specifically in the `render()` or `get_size()` calls. The style value
-may be a bit-wise <tt class="docutils literal"><span class="pre">OR</span></tt> of one or more of the following constants:</p>
+specifically in the <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a> or <tt class="xref py py-meth docutils literal"><span class="pre">get_size()</span></tt> calls.
+The style value may be a bit-wise OR of one or more of the following
+constants:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="n">STYLE_NONE</span>
 <span class="n">STYLE_UNDERLINE</span>
 <span class="n">STYLE_OBLIQUE</span>
 <p>These constants may be found on the FreeType constants module.
 Optionally, the default style can be modified or obtained accessing the
 individual style attributes (underline, oblique, strong).</p>
-<p>The <tt class="docutils literal"><span class="pre">STYLE_OBLIQUE</span></tt> and <tt class="docutils literal"><span class="pre">STYLE_STRONG</span></tt> styles are for scalable fonts
-only. An attempt to set either for a bitmap font raises an AttributeError.
-An attempt to set either for an inactive font, as returned by
-<tt class="docutils literal"><span class="pre">Font.__new__()</span></tt>, raises a RuntimeError.</p>
+<p>The <tt class="xref py py-const docutils literal"><span class="pre">STYLE_OBLIQUE</span></tt> and <tt class="xref py py-const docutils literal"><span class="pre">STYLE_STRONG</span></tt> styles are for
+scalable fonts only. An attempt to set either for a bitmap font raises
+an AttributeError. An attempt to set either for an inactive font,
+as returned by <tt class="xref py py-meth docutils literal"><span class="pre">Font.__new__()</span></tt>, raises a RuntimeError.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 </div>
 <p>Gets or sets whether the font will be underlined when drawing text. This
 default style value will be used for all text rendering and size
-calculations unless overridden specifically in the `render()` or
-`get_size()` calls, via the &#8216;style&#8217; parameter.</p>
+calculations unless overridden specifically in the <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a> or
+<tt class="xref py py-meth docutils literal"><span class="pre">get_size()</span></tt> calls, via the &#8216;style&#8217; parameter.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 </div>
 <p>Gets or sets whether the font will be bold when drawing text. This
 default style value will be used for all text rendering and size
-calculations unless overridden specifically in the `render()` or
-`get_size()` calls, via the &#8216;style&#8217; parameter.</p>
+calculations unless overridden specifically in the <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a> or
+<tt class="xref py py-meth docutils literal"><span class="pre">get_size()</span></tt> calls, via the &#8216;style&#8217; parameter.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 </div>
 <p>Gets or sets whether the font will be rendered as oblique. This
 default style value will be used for all text rendering and size
-calculations unless overridden specifically in the `render()` or
-`get_size()` calls, via the &#8216;style&#8217; parameter.</p>
+calculations unless overridden specifically in the <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a> or
+<tt class="xref py py-meth docutils literal"><span class="pre">get_size()</span></tt> calls, via the <em>style</em> parameter.</p>
 <p>The oblique style is only supported for scalable (outline) fonts.
-An attempt to set this property will raise an AttributeError.
-If the font object is inactive, as returned by Font.__new__,
-setting this property raises a RuntimeError.</p>
+An attempt to set this style on a bitmap font will raise an
+AttributeError. If the font object is inactive, as returned by
+<tt class="xref py py-meth docutils literal"><span class="pre">Font.__new__()</span></tt>, setting this property raises a RuntimeError.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <div class="line"><span class="signature">wide -&gt; bool</span></div>
 </div>
 <p>Gets or sets whether the font will be stretched horizontally
-when drawing text. It produces a result similar to font.Font&#8217;s
-bold. This style is only available for unrotated text.</p>
+when drawing text. It produces a result similar to
+<a class="tooltip reference internal" href="font.html#pygame.font.Font" title=""><tt class="xref py py-class docutils literal"><span class="pre">pygame.font.Font</span></tt><span class="tooltip-content">create a new Font object from a file</span></a>&#8216;s bold. This style not available for
+rotated text.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 strong or wide transformations, as a fraction of the untransformed
 size. For the wide style only the horizontal dimension is
 increased. For strong text both the horizontal and vertical
-dimensions are enlarged. A wide style of strength 1/12 is
-equivalent to the font.Font bold style. The default is 1/36.</p>
+dimensions are enlarged. A wide style of strength 0.08333 ( 1/12 ) is
+equivalent to the <a class="tooltip reference internal" href="font.html#pygame.font.Font" title=""><tt class="xref py py-class docutils literal"><span class="pre">pygame.font.Font</span></tt><span class="tooltip-content">create a new Font object from a file</span></a> bold style.
+The default is 0.02778 ( 1/36 ).</p>
 <p>The strength style is only supported for scalable (outline) fonts.
-An attempt to set this property will raise an AttributeError.
-If the font object is inactive, as returned by Font.__new__,
-setting this property raises a RuntimeError.</p>
+An attempt to set this property on a bitmap font will raise an
+AttributeError. If the font object is inactive, as returned by
+<tt class="xref py py-meth docutils literal"><span class="pre">Font.__new__()</span></tt>, assignment to this property raises a RuntimeError.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <p>Gets or sets a factor which, when positive, is multiplied with the
 font&#8217;s underline offset to adjust the underline position. A negative
 value turns an underline into a strike-through or overline. It is
-multiplied with the ascender. Accepted values are between -2.0 and 2.0
+multiplied with the ascender. Accepted values range between -2.0 and 2.0
 inclusive. A value of 0.5 closely matches Tango underlining. A value of
-1.0 mimics SDL_ttf.</p>
+1.0 mimics <a class="tooltip reference internal" href="font.html#pygame.font.Font" title=""><tt class="xref py py-class docutils literal"><span class="pre">pygame.font.Font</span></tt><span class="tooltip-content">create a new Font object from a file</span></a> underlining.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <div class="line"><span class="summaryline">Gets whether the font is fixed-width</span></div>
 <div class="line"><span class="signature">fixed_width -&gt; bool</span></div>
 </div>
-<p>Read only. Return True if the font contains fixed-width characters
-(for example Courier, Bitstream Vera Sans Mono, Andale Mono).</p>
+<p>Read only. Returns <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> if the font contains fixed-width
+characters (for example Courier, Bitstream Vera Sans Mono, Andale Mono).</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <dt class="title" id="pygame.freetype.Font.fixed_sizes">
 <tt class="descname">fixed_sizes</tt><a class="headerlink" href="#pygame.freetype.Font.fixed_sizes" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">
-<div class="line"><span class="summaryline">the number of embedded bitmap sizes the font</span></div>
+<div class="line"><span class="summaryline">the number of available bitmap sizes for the font</span></div>
 <div class="line"><span class="signature">fixed_sizes -&gt; int</span></div>
 </div>
-<p>Read only. Return the number of point sizes for which the font contains
+<p>Read only. Returns the number of point sizes for which the font contains
 bitmap character images. If zero then the font is not a bitmap font.
-A scalable font may contain pre-rendered point sizes.</p>
+A scalable font may contain pre-rendered point sizes as strikes.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <div class="line"><span class="summaryline">Gets whether the font is scalable</span></div>
 <div class="line"><span class="signature">scalable -&gt; bool</span></div>
 </div>
-<p>Read only. Return True if the font contains outline glyphs. If so,
-the point size is not limited to available bitmap sizes.</p>
+<p>Read only. Returns <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> if the font contains outline glyphs.
+If so, the point size is not limited to available bitmap sizes.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <dt class="title" id="pygame.freetype.Font.use_bitmap_strikes">
 <tt class="descname">use_bitmap_strikes</tt><a class="headerlink" href="#pygame.freetype.Font.use_bitmap_strikes" title="Permalink to this definition">¶</a></dt>
 <dd><div class="line-block">
-<div class="line"><span class="summaryline">allow the use of embeddeded bitmaps in an outline font file</span></div>
+<div class="line"><span class="summaryline">allow the use of embedded bitmaps in an outline font file</span></div>
 <div class="line"><span class="signature">use_bitmap_strikes -&gt; bool</span></div>
 </div>
-<p>Some scalable fonts contain embedded bitmaps for particular point
+<p>Some scalable fonts include embedded bitmaps for particular point
 sizes. This property controls whether or not those bitmap strikes
-are used. Setting <tt class="docutils literal"><span class="pre">False</span></tt> disables the loading of any bitmap strike.
-Setting <tt class="docutils literal"><span class="pre">True</span></tt>, the default value, allows bitmap strikes for an
-unrotated render when no style other than <a class="reference internal" href="#pygame.freetype.Font.wide" title="pygame.freetype.Font.wide"><tt class="xref py py-attr docutils literal"><span class="pre">wide</span></tt></a> or
-<a class="reference internal" href="#pygame.freetype.Font.underline" title="pygame.freetype.Font.underline"><tt class="xref py py-attr docutils literal"><span class="pre">underline</span></tt></a> is set. This property has no effect on bitmap fonts.</p>
+are used. Set it <tt class="xref py py-const docutils literal"><span class="pre">False</span></tt> to disable the loading of any bitmap
+strike. Set it <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt>, the default, to permit bitmap strikes
+for a nonrotated render with no style other than <a class="reference internal" href="#pygame.freetype.Font.wide" title="pygame.freetype.Font.wide"><tt class="xref py py-attr docutils literal"><span class="pre">wide</span></tt></a> or
+<a class="reference internal" href="#pygame.freetype.Font.underline" title="pygame.freetype.Font.underline"><tt class="xref py py-attr docutils literal"><span class="pre">underline</span></tt></a>. This property is ignored for bitmap fonts.</p>
 <p>See also <a class="reference internal" href="#pygame.freetype.Font.fixed_sizes" title="pygame.freetype.Font.fixed_sizes"><tt class="xref py py-attr docutils literal"><span class="pre">fixed_sizes</span></tt></a> and <a class="reference internal" href="#pygame.freetype.Font.get_sizes" title="pygame.freetype.Font.get_sizes"><tt class="xref py py-meth docutils literal"><span class="pre">get_sizes()</span></tt></a>.</p>
 </dd></dl>
 
 <div class="line"><span class="summaryline">Font anti-aliasing mode</span></div>
 <div class="line"><span class="signature">antialiased -&gt; bool</span></div>
 </div>
-<p>Gets or sets the font&#8217;s anti-aliasing mode. This defaults to <tt class="docutils literal"><span class="pre">True</span></tt> on
-all fonts, which are rendered with full 8 bit blending.</p>
-<p>Setting this to <tt class="docutils literal"><span class="pre">False</span></tt> will enable monochrome rendering. This should
+<p>Gets or sets the font&#8217;s anti-aliasing mode. This defaults to
+<tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> on all fonts, which are rendered with full 8 bit blending.</p>
+<p>Set to <tt class="xref py py-const docutils literal"><span class="pre">False</span></tt> to do monochrome rendering. This should
 provide a small speed gain and reduce cache memory size.</p>
 </dd></dl>
 
 <div class="line"><span class="summaryline">Character kerning mode</span></div>
 <div class="line"><span class="signature">kerning -&gt; bool</span></div>
 </div>
-<p>Gets or sets the font&#8217;s kerning mode. This defaults to False on all
-fonts, which will be rendered by default without kerning.</p>
-<p>Setting this to true will change all rendering methods to do kerning
-between character pairs for surface size calculation and all
-render operations.</p>
+<p>Gets or sets the font&#8217;s kerning mode. This defaults to <tt class="xref py py-const docutils literal"><span class="pre">False</span></tt>
+on all fonts, which will be rendered without kerning.</p>
+<p>Set to <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> to add kerning between character pairs, if supported
+by the font, when positioning glyphs.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <div class="line"><span class="summaryline">Font vertical mode</span></div>
 <div class="line"><span class="signature">vertical -&gt; bool</span></div>
 </div>
-<p>Gets or sets whether the font is a vertical font such as fonts in fonts
-representing Kanji glyphs or other styles of vertical writing.</p>
-<p>Changing this attribute will cause the font to be rendering vertically,
-and affects all other methods which manage glyphs or text layouts to use
-vertical metrics accordingly.</p>
-<p>Note that the FreeType library doesn&#8217;t automatically detect whether a
-font contains glyphs which are always supposed to be drawn vertically, so
-this attribute must be set manually by the user.</p>
+<p>Gets or sets whether the characters are laid out vertically rather
+than horizontally. May be useful when rendering Kanji or some other
+vertical script.</p>
+<p>Set to <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> to switch to a vertical text layout. The default
+is <tt class="xref py py-const docutils literal"><span class="pre">False</span></tt>, place horizontally.</p>
+<p>Note that the <a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a> class does not automatically determine
+script orientation. Vertical layout must be selected explicitly.</p>
 <p>Also note that several font formats (especially bitmap based ones) don&#8217;t
 contain the necessary metrics to draw glyphs vertically, so drawing in
 those cases will give unspecified results.</p>
 <div class="line"><span class="summaryline">text rotation in degrees counterclockwise</span></div>
 <div class="line"><span class="signature">rotation -&gt; int</span></div>
 </div>
-<p>Get or set the baseline angle of the rendered text. The angle is
+<p>Gets or sets the baseline angle of the rendered text. The angle is
 represented as integer degrees. The default angle is 0, with horizontal
-text rendered along the X axis, and vertical text along the Y axis.
-A non-zero value rotates these axes counterclockwise that many degrees.
-Degree values outside of the range 0 to 359 inclusive are reduced to the
-corresponding angle within the range (eg. 390 -&gt; 390 - 360 -&gt; 30,
--45 -&gt; 360 + -45 -&gt; 315, 720 -&gt; 720 - (2 * 360) -&gt; 0).</p>
-<p>Text rotation is only supported for scalable (outline) fonts. An attempt
-to change the rotation of a bitmap font raises an AttributeError.
-An attempt to change the rotation of an inactive font objects, as
-returned by Font.__new__(), raises a RuntimeError.</p>
+text rendered along the X-axis, and vertical text along the Y-axis.
+A positive value rotates these axes counterclockwise that many degrees.
+A negative angle corresponds to a clockwise rotation. The rotation
+value is normalized to a value within the range 0 to 359 inclusive
+(eg. 390 -&gt; 390 - 360 -&gt; 30, -45 -&gt; 360 + -45 -&gt; 315,
+720 -&gt; 720 - (2 * 360) -&gt; 0).</p>
+<p>Only scalable (outline) fonts can be rotated. An attempt to change
+the rotation of a bitmap font raises an AttributeError.
+An attempt to change the rotation of an inactive font instance, as
+returned by <tt class="xref py py-meth docutils literal"><span class="pre">Font.__new__()</span></tt>, raises a RuntimeError.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <div class="line"><span class="summaryline">default foreground color</span></div>
 <div class="line"><span class="signature">fgcolor -&gt; Color</span></div>
 </div>
-<p>Get or set the default glyph rendering color. It is initially opaque
+<p>Gets or sets the default glyph rendering color. It is initially opaque
 black ― (0, 0, 0, 255). Applies to <a class="reference internal" href="#pygame.freetype.Font.render" title="pygame.freetype.Font.render"><tt class="xref py py-meth docutils literal"><span class="pre">render()</span></tt></a> and <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a>.</p>
 </dd></dl>
 
 <div class="line"><span class="summaryline">Font render to text origin mode</span></div>
 <div class="line"><span class="signature">origin -&gt; bool</span></div>
 </div>
-<p>If set True, then when rendering to an existing surface, the position
-is taken to be that of the text origin. Otherwise the render position is
-the top-left corner of the text bounding box.</p>
+<p>If set <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt>, <a class="reference internal" href="#pygame.freetype.Font.render_to" title="pygame.freetype.Font.render_to"><tt class="xref py py-meth docutils literal"><span class="pre">render_to()</span></tt></a> and <tt class="xref py py-meth docutils literal"><span class="pre">render_to_raw()</span></tt> will
+take the <em>dest</em> position to be that of the text origin, as opposed to
+the top-left corner of the bounding box. See <a class="reference internal" href="#pygame.freetype.Font.get_rect" title="pygame.freetype.Font.get_rect"><tt class="xref py py-meth docutils literal"><span class="pre">get_rect()</span></tt></a> for
+details.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <div class="line"><span class="summaryline">padded boundary mode</span></div>
 <div class="line"><span class="signature">pad -&gt; bool</span></div>
 </div>
-<p>If set True, then the text boundary rectangle will be inflated to match
-that of font.Font. Otherwise, the boundary rectangle is just large
-enough for the text.</p>
+<p>If set <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt>, then the text boundary rectangle will be inflated
+to match that of <tt class="xref py py-class docutils literal"><span class="pre">font.Font</span></tt>. Otherwise, the boundary rectangle
+is just large enough for the text.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 interpreters built with a UCS-2 unicode type (on Windows, for instance).
 It also means character values within the UTF-16 surrogate area (0xD800
 to 0xDFFF) are considered part of a surrogate pair. A malformed surrogate
-pair will raise an UnicodeEncodeError. Setting ucs4 True turns surrogate
-pair decoding off, letting interpreters with a UCS-4 unicode type access
-the full UCS-4 character range.</p>
+pair will raise a UnicodeEncodeError. Setting ucs4 <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> turns
+surrogate pair decoding off, allowing access the full UCS-4 character
+range to a Python interpreter built with four byte unicode character
+support.</p>
 </dd></dl>
 
 <dl class="definition attribute">
 <div class="line"><span class="summaryline">Pixel resolution in dots per inch</span></div>
 <div class="line"><span class="signature">resolution -&gt; int</span></div>
 </div>
-<p>Gets the pixel size used in scaling font glyphs for this Font instance.</p>
+<p>Read only. Gets pixel size used in scaling font glyphs for this
+<a class="reference internal" href="#pygame.freetype.Font" title="pygame.freetype.Font"><tt class="xref py py-class docutils literal"><span class="pre">Font</span></tt></a> instance.</p>
 </dd></dl>
 
 </dd></dl>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.