Source

pygame / doc / src / sdlttfbase.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE module SYSTEM "api.dtd">

<module name="pygame2.sdlttf.base">
  <show>0</show>
  <alias>pygame2.sdlttf</alias>
  <short>basic SDL_ttf wrapper module</short>
  <desc>
    Basic SDL_ttf wrapper module
  </desc>

  <class name="Font">
    <constructor>Font (file, size[, index]) -> Font</constructor>
    <desc>
      Creates a new Font from a TTF font file.
      
      Creates a new Font from a TTF font *file* using the specified *size* in
      points. If the font features different faces, they can be chosen using
      the optional *index*.

      .. note::

        The *file* object *must* support binary read and write
        access. This is especially important for Python 3.x users.
    </desc>
    <attr name="ascent">
      <desc>Gets the ascent of the Font.</desc>
    </attr>
    <attr name="descent">
      <desc>Gets the descent of the Font.</desc>
    </attr>
    <attr name="faces">
      <desc>Gets the amount of available font faces.</desc>
    </attr>
    <attr name="family_name">
      <desc>Gets the font face family name.</desc>
    </attr>
    <method name="get_glyph_metrics">
      <call>get_glyph_metrics (text) -> [(int,int,int,int,int), ...]</call>
      <desc>
        Gets the glyph metrics of a string.
        
        Gets the glyph metrics for each individual character of a string.
        The metrics returned for each character consist of the xMin, yMin,
        xMax, yMax and advance values. 
        
        http://freetype.sourceforge.net/freetype2/docs/tutorial/step2.html
        contains a detailed description of those values.
        
        If no suitable character for getting the glyph extents could be found
        in the font, a None value will be used instead of a 5-value tuple.
      </desc>
    </method>
    <method name="get_size">
      <call>get_size (text) -> int, int</call>
      <desc>
        Gets the size of a text for this Font.
      </desc>
    </method>
    <attr name="height">
      <desc>Gets the height of the Font.</desc>
    </attr>
    <attr name="is_fixed_width">
      <desc>Gets whether the chosen font face is a fixed width one.</desc>
    </attr>
    <attr name="line_skip">
      <desc>Gets the line skip of the Font.</desc>
    </attr>
    <method name="render">
      <call>render (text, fgcolor[, bgcolor, renderflag]) -> :class:`pygame2.sdl.video.Surface`</call>
      <desc>
        Renders a text to a :class:`pygame2.sdl.video.Surface`.
        
        Renders the specified *text* to a :class:`pygame2.sdl.video.Surface`.
        The text will have the chosen foreground color for the glyphs. The
        optional *bgcolor* argument denotes the background color to use for the
        returned :class:`pygame2.sdl.video.Surface`, if - and only if -
        the *renderflag* is RENDER_SHADED (the default). Otherwise the
        :class:`pygame2.sdl.video.Surface` will be transparent except for the
        rendered glyphs.
        
        The *renderflag argument* can be set to one of the rendering constants
        of the :mod:`pygame2.sdlttf.constants` module.
      </desc>
    </method>
    <attr name="style">
      <desc>Gets or sets the style of the font. The style can be a valid
      value of the style constants in the :mod:`pygame2.sdlttf.constants`
      module.</desc>
    </attr>
    <attr name="style_name">
      <desc>Gets the currently set font style name.</desc>
    </attr>
  </class>

  <func name="get_compiled_version">
    <call>get_compiled_version () -> (int, int, int)</call>
    <desc>
      Gets the SDL_ttf version pygame2 was compiled against as
      three-value tuple.

      This version is built at compile time. It can be used to detect
      which features may not be available through Pygame, if it is used
      as precompiled package using a different version of the SDL_ttf
      library.    
    </desc>
  </func>
  <func name="get_error">
    <call>get_error () -> :exc:`pygame2.Error`</call>
    <desc>
      Gets the last :exc:`pygame2.Error` occured.

      SDL_ttf maintains an internal error message. This message will usually
      be given to you when a :exc:`pygame2.Error` is raised. You will
      rarely need to call this function.
    </desc>
  </func>
  <func name="get_version">
    <call>get_version () -> (int, int, int)</call>
    <desc>
      Gets the SDL version pygame2 currently uses as three-value tuple.

      This version is detected at runtime. It can be used to detect
      which features may not be available through Pygame, if it is used
      as precompiled package using a different version of the SDL library.
    </desc>
  </func>
  <func name="init">
    <call>init () -> None</call>
    <desc>
      Initializes the SDL_ttf library.
    </desc>
  </func>
  <func name="quit">
    <call>quit () -> None</call>
    <desc>
      Shuts down the SDL_ttf library.

      After calling this function, you should not invoke any class,
      method or function related to the sdlttf module as they are likely to
      fail or might give unpredictable results.
    </desc>
  </func>
  <func name="set_byte_swapped_unicode">
    <call>set_byte_swapped_unicode (swapped) -> None</call>
    <desc>
      Sets, whether unicode text should be handled with a swapped BOM.
    </desc>
  </func>
  <func name="was_init">
    <call>was_init () -> bool</call>
    <desc>
      Returns, whether the the SDL_ttf library is initialized.
    </desc>
  </func>
</module>