pygame / docs / ref / Font.html

Full commit
<body bgcolor=#dddddd text=#333377 link=#7777bb vlink=#7777bb>

<table border=0 width=100% cellpadding=0 cellspacing=0 bgcolor=#f5f5f5><tr valign=top>
<td rowspan=2><table border=0 cellpadding=5 cellspacing=0 bgcolor=#333377>
<tr height=86 align=left><td valign=middle><font color=#ffffff size=+5>
	<a href=../index.html><font size=+5 color=#ffffff><i><b>
<td valign=middle><tt><font color=#dddddd><br>
</td></tr></table></td><td width=100% align=center valign=middle>

	<a href=>Home</a> &nbsp;||&nbsp;
	<a href=../index.html>Help Contents</a> &nbsp;||

|| <a href=CD.html>CD</a> || 
<a href=Channel.html>Channel</a> || 
<a href=Font.html>Font</a> || 
<a href=Joystick.html>Joystick</a> || 
<a href=Rect.html>Rect</a> || 
<a href=Sound.html>Sound</a> || 
<a href=Surface.html>Surface</a> ||<br>
|| <a href=pygame.html>pygame</a> || 
<a href=pygame_cdrom.html>cdrom</a> || 
<a href=pygame_constants.html>constants</a> || 
<a href=pygame_display.html>display</a> || 
<a href=pygame_event.html>event</a> || 
<a href=pygame_font.html>font</a> || 
<a href=pygame_image.html>image</a> ||<br>
|| <a href=pygame_joystick.html>joystick</a> || 
<a href=pygame_key.html>key</a> || 
<a href=pygame_mixer.html>mixer</a> || 
<a href=pygame_mixer_music.html>mixer_music</a> || 
<a href=pygame_mouse.html>mouse</a> || 
<a href=pygame_surfarray.html>surfarray</a> || 
<a href=pygame_time.html>time</a> ||<br>

<h2 align=center>Font</h2>
The font object is created only from pygame.font.font(). Once a
font is created it's size and TTF file cannot be changed. The
Font objects are mainly used to render() text into a new Surface.
The Font objects also have a few states that can be set with
set_underline(bool), set_bold(bool), set_italic(bool). Each of
these functions contains an equivalent get_XXX() routine to find
the current state. There are also many routines to query the
dimensions of the text. The rendering functions work with both
normal python strings, as well as with unicode strings.


<tr><td><a href=#get_ascent>get_ascent</a></td><td> -
gets the font ascent</td></tr>

<tr><td><a href=#get_bold>get_bold</a></td><td> -
status of the bold attribute</td></tr>

<tr><td><a href=#get_bold>get_bold</a></td><td> -
status of the italic attribute</td></tr>

<tr><td><a href=#get_descent>get_descent</a></td><td> -
gets the font descent</td></tr>

<tr><td><a href=#get_height>get_height</a></td><td> -
average height of font glyph</td></tr>

<tr><td><a href=#get_linesize>get_linesize</a></td><td> -
gets the font recommended linesize</td></tr>

<tr><td><a href=#get_underline>get_underline</a></td><td> -
status of the underline attribute</td></tr>

<tr><td><a href=#render>render</a></td><td> -
render text to a new image</td></tr>

<tr><td><a href=#set_bold>set_bold</a></td><td> -
assign the bold attribute</td></tr>

<tr><td><a href=#set_italic>set_italic</a></td><td> -
assign the italic attribute</td></tr>

<tr><td><a href=#set_underline>set_underline</a></td><td> -
assign the underline attribute</td></tr>

<tr><td><a href=#size>size</a></td><td> -
size of rendered text</td></tr>



<a name=get_ascent><font size=+2><b>get_ascent
</b></font><br><font size=+1><tt>
Font.get_ascent() -> int
Returns the ascent for the font. The ascent is the number of
pixels from the font baseline to the top of the font.

<a name=get_bold><font size=+2><b>get_bold
</b></font><br><font size=+1><tt>
Font.get_bold() -> bool
Get the current status of the font's bold attribute

<a name=get_bold><font size=+2><b>get_bold
</b></font><br><font size=+1><tt>
Font.get_bold() -> bool
Get the current status of the font's italic attribute

<a name=get_descent><font size=+2><b>get_descent
</b></font><br><font size=+1><tt>
Font.get_descent() -> int
Returns the descent for the font. The descent is the number of
pixels from the font baseline to the bottom of the font.

<a name=get_height><font size=+2><b>get_height
</b></font><br><font size=+1><tt>
Font.get_height() -> int
Returns the average size of each glyph in the font.

<a name=get_linesize><font size=+2><b>get_linesize
</b></font><br><font size=+1><tt>
Font.get_linesize() -> int
Returns the linesize for the font. Each font comes with it's own
recommendation for the spacing number of pixels between each line
of the font.

<a name=get_underline><font size=+2><b>get_underline
</b></font><br><font size=+1><tt>
Font.get_underline() -> bool
Get the current status of the font's underline attribute

<a name=render><font size=+2><b>render
</b></font><br><font size=+1><tt>
Font.render(text, antialias, fore_RGBA, [back_RGBA]) -> Surface
Render the given text onto a new image surface. The given text
can be standard python text or unicode. Antialiasing will smooth
the edges of the font for a much cleaner look. The foreground
and background color are both RGBA, the alpha component is ignored
if given. If the background color is omitted, the text will have a
a transparent background.

<a name=set_bold><font size=+2><b>set_bold
</b></font><br><font size=+1><tt>
Font.set_bold(bool) -> None
Enables or disables the bold attribute for the font. Making the
font bold does not work as well as you expect.

<a name=set_italic><font size=+2><b>set_italic
</b></font><br><font size=+1><tt>
Font.set_italic(bool) -> None
Enables or disables the italic attribute for the font.

<a name=set_underline><font size=+2><b>set_underline
</b></font><br><font size=+1><tt>
Font.set_underline(bool) -> None
Enables or disables the underline attribute for the font.

<a name=size><font size=+2><b>size
</b></font><br><font size=+1><tt>
Font.size(text) -> width, height
Computes the rendered size of the given text. The text can be
standard python text or unicode. Changing the bold and italic
attributes can change the size of the rendered text.