~ubuntu-branches/ubuntu/maverick/pygame/maverick

<td bgcolor='#c2fc20' style='padding: 6px;' align=center valign=center><a href='http://www.pygame.org/'><img src='../pygame_tiny.gif' border=0 width=200 height=60></a> pygame documentation</td>

<a href=http://www.pygame.org>Pygame Home</a>  ||

<a href=../index.html>Help Contents</a>  ||

<a href=index.html>Reference Index</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="font.html">Font</a> ||

<a href="image.html">Image</a> ||

<a href="joystick.html">Joystick</a> ||

<a href="key.html">Key</a> ||

<a href="mask.html">Mask</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="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="time.html">Time</a> ||

<a href="transform.html">Transform</a>

</td></tr></table>

<big>pygame.font</big> <ul>

pygame module for loading and rendering fonts

<tr><td><a href="font.html#pygame.font.init">pygame.font.init</a> - initialize the font module</td><td>initialize the font module</td></tr>

<tr><td><a href="font.html#pygame.font.quit">pygame.font.quit</a> - uninitialize the font module</td><td>uninitialize the font module</td></tr>

<tr><td><a href="font.html#pygame.font.get_init">pygame.font.get_init</a> - true if the font module is initialized</td><td>true if the font module is initialized</td></tr>

<tr><td><a href="font.html#pygame.font.get_default_font">pygame.font.get_default_font</a> - get the filename of the default font</td><td>get the filename of the default font</td></tr>

<tr><td><a href="font.html#pygame.font.get_fonts">pygame.font.get_fonts</a> - get all available fonts</td><td>get all available fonts</td></tr>

<tr><td><a href="font.html#pygame.font.match_font">pygame.font.match_font</a> - find a specific font on the system</td><td>find a specific font on the system</td></tr>

<tr><td><a href="font.html#pygame.font.SysFont">pygame.font.SysFont</a> - create a Font object from the system fonts</td><td>create a Font object from the system fonts</td></tr>

<tr><td><a href="font.html#pygame.font.Font">pygame.font.Font</a> - create a new Font object from a file</td><td>create a new Font object from a file</td></tr>

</table></ul>

The font module allows for rendering TrueType fonts into a new Surface object. This module is optional and requires SDL_ttf as a dependency. You should test that <tt>pygame.font</tt> is available and initialized before attempting to use the module.

Most of the work done with fonts are done by using the actual Font objects. The module by itself only has routines to initialize the module and create Font objects with <tt><a href="font.html#pygame.font.Font">pygame.font.Font</a> - create a new Font object from a file</tt>.

You can load fonts from the system by using the <tt><a href="font.html#pygame.font.SysFont">pygame.font.SysFont</a> - create a Font object from the system fonts</tt> function. There are a few other functions to help lookup the system fonts.

Pygame comes with a builtin default font. This can always be accessed by passing None as the font name.

<big>pygame.font.init</big> <ul>

initialize the font module

<tt>pygame.font.init(): return None</tt>

This method is called automatically by <tt><a href="pygame.html#pygame.init">pygame.init</a> - initialize all imported pygame modules</tt>. It initializes the font module. The module must be initialized before any other functions will work.

It is safe to call this function more than once.

</ul>

<big>pygame.font.quit</big> <ul>

uninitialize the font module

<tt>pygame.font.quit(): return None</tt>

Manually uninitialize SDL_ttf's font system. This is called automatically by <tt><a href="pygame.html#pygame.quit">pygame.quit</a> - uninitialize all pygame modules</tt>.

It is safe to call this function even if font is currently not initialized.

</ul>

<big>pygame.font.get_init</big> <ul>

true if the font module is initialized

<tt>pygame.font.get_init(): return bool</tt>

Test if the font module is initialized or not.

</ul>

<big>pygame.font.get_default_font</big> <ul>

get the filename of the default font

<tt>pygame.font.get_default_font(): return string</tt>

100

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.

101

102

</ul>

103

104

105

106

<big>pygame.font.get_fonts</big> <ul>

107

get all available fonts

108

<tt>pygame.font.get_fonts(): return list of strings</tt>

109

Returns a list of all the fonts available on the system. The names of the fonts will be set to lowercase with all spaces and punctuation removed. This works on most systems, but some will return an empty list if they cannot find fonts.

110

111

</ul>

112

113

114

115

<big>pygame.font.match_font</big> <ul>

116

find a specific font on the system

117

<tt>pygame.font.match_font(name, bold=False, italic=False): return path</tt>

118

Returns the full path to a font file on the system. If bold or italic are set to true, this will attempt to find the correct family of font.

119

The font name can actually be a comma separated list of font names to try. If none of the given names are found, None is returned.

120

Example:

121

<pre> print pygame.font.match_font('bitstreamverasans')

122

# output is: /usr/share/fonts/truetype/ttf-bitstream-vera/Vera.ttf

123

# (but only if you have Vera on your system)

124

</pre>

125

126

</ul>

127

128

129

130

<big>pygame.font.SysFont</big> <ul>

131

create a Font object from the system fonts

132

<tt>pygame.font.SysFont(name, size, bold=False, italic=False): return Font</tt>

133

Return a new Font object that is loaded from the system fonts. The font will match the requested bold and italic flags. If a suitable system font is not found this will fallback on loading the default pygame font. The font name can be a comma separated list of font names to look for.

134

135

</ul>

136

137

138

139

<big>pygame.font.Font</big> <ul>

140

create a new Font object from a file

141

<tt>pygame.font.Font(filename, size): return Font</tt>

142

<tt>pygame.font.Font(object, size): return Font</tt>

143

144

<tr><td><a href="font.html#Font.render">Font.render</a> - draw text on a new Surface</td><td>draw text on a new Surface</td></tr>

145

<tr><td><a href="font.html#Font.size">Font.size</a> - determine the amount of space needed to render text</td><td>determine the amount of space needed to render text</td></tr>

146

<tr><td><a href="font.html#Font.set_underline">Font.set_underline</a> - control if text is rendered with an underline</td><td>control if text is rendered with an underline</td></tr>

147

<tr><td><a href="font.html#Font.get_underline">Font.get_underline</a> - check if text will be rendered with an underline</td><td>check if text will be rendered with an underline</td></tr>

148

<tr><td><a href="font.html#Font.set_bold">Font.set_bold</a> - enable fake rendering of bold text</td><td>enable fake rendering of bold text</td></tr>

149

<tr><td><a href="font.html#Font.get_bold">Font.get_bold</a> - check if text will be rendered bold</td><td>check if text will be rendered bold</td></tr>

150

<tr><td><a href="font.html#Font.set_italic">Font.set_italic</a> - enable fake rendering of italic text</td><td>enable fake rendering of italic text</td></tr>

151

<tr><td><a href="font.html#Font.metrics">Font.metrics</a> - Gets the metrics for each character in the pased string.</td><td>Gets the metrics for each character in the pased string.</td></tr>

152

<tr><td><a href="font.html#Font.get_italic">Font.get_italic</a> - check if the text will be rendered italic</td><td>check if the text will be rendered italic</td></tr>

153

<tr><td><a href="font.html#Font.get_linesize">Font.get_linesize</a> - get the line space of the font text</td><td>get the line space of the font text</td></tr>

154

<tr><td><a href="font.html#Font.get_height">Font.get_height</a> - get the height of the font</td><td>get the height of the font</td></tr>

155

<tr><td><a href="font.html#Font.get_ascent">Font.get_ascent</a> - get the ascent of the font</td><td>get the ascent of the font</td></tr>

156

<tr><td><a href="font.html#Font.get_descent">Font.get_descent</a> - get the descent of the font</td><td>get the descent of the font</td></tr>

157

</table></ul>

158

Load a new font from a given filename or a python file object. The size is the height of the font in pixels. If the filename is None the Pygame default font will be loaded. If a font cannot be loaded from the arguments given an exception will be raised. Once the font is created the size cannot be changed.

159

Font objects are mainly used to render text into new Surface objects. The render can emulate bold or italic features, but it is better to load from a font with actual italic or bold glyphs. The rendered text can be regular strings or unicode.

160

161

162

163

164

<big>Font.render</big> <ul>

165

draw text on a new Surface

166

<tt>Font.render(text, antialias, color, background=None): return Surface</tt>

167

This creates a new Surface with the specified text rendered on it. Pygame provides no way to directly draw text on an existing Surface: instead you must use <tt><a href="font.html#Font.render">Font.render</a> - draw text on a new Surface</tt> to create an image (Surface) of the text, then blit this image onto another Surface.

168

The text can only be a single line: newline characters are not rendered. The antialias argument is a boolean: if true the characters will have smooth edges. The color argument is the color of the text <tt>[e.g.:</tt> (0,0,255) for blue]. The optional background argument is a color to use for the text background. If no background is passed the area outside the text will be transparent.

169

The Surface returned will be of the dimensions required to hold the text. (the same as those returned by <tt>Font.size())</tt>. If an empty string is passed for the text, a blank surface will be returned that is one pixel wide and the height of the font.

170

Depending on the type of background and antialiasing used, this returns different types of Surfaces. For performance reasons, it is good to know what type of image will be used. If antialiasing is not used, the return image will always be an 8bit image with a two color palette. If the background is transparent a colorkey will be set. Antialiased images are rendered to 24-bit <tt>RGB</tt> images. If the background is transparent a pixel alpha will be included.

171

Optimization: if you know that the final destination for the text (on the screen) will always have a solid background, and the text is antialiased, you can improve performance by specifying the background color. This will cause the resulting image to maintain transparency information by colorkey rather than (much less efficient) alpha values.

172

If you render '\n' a unknown char will be rendered. Usually a rectangle. Instead you need to handle new lines yourself.

173

Font rendering is not thread safe: only a single thread can render text any time.

174

175

</ul>

176

177

178

179

180

determine the amount of space needed to render text

181

<tt>Font.size(text): return (width, height)</tt>

182

Returns the dimensions needed to render the text. This can be used to help determine the positioning needed for text before it is rendered. It can also be used for wordwrapping and other layout effects.

183

Be aware that most fonts use kerning which adjusts the widths for specific letter pairs. For example, the width for "ae" will not always match the width for "a" + "e".

184

185

</ul>

186

187

188

189

<big>Font.set_underline</big> <ul>

190

control if text is rendered with an underline

191

<tt>Font.set_underline(bool): return None</tt>

192

When enabled, all rendered fonts will include an underline. The underline is always one pixel thick, regardless of font size. This can be mixed with the bold and italic modes.

193

194

</ul>

195

196

197

198

<big>Font.get_underline</big> <ul>

199

check if text will be rendered with an underline

200

<tt>Font.get_underline(): return bool</tt>

201

Return True when the font underline is enabled.

202

203

</ul>

204

205

206

207

208

enable fake rendering of bold text

209

<tt>Font.set_bold(bool): return None</tt>

210

Enables the bold rendering of text. This is a fake stretching of the font that doesn't look good on many font types. If possible load the font from a real bold font file. While bold, the font will have a different width than when normal. This can be mixed with the italic and underline modes.

211

212

</ul>

213

214

215

216

217

check if text will be rendered bold

218

<tt>Font.get_bold(): return bool</tt>

219

Return True when the font bold rendering mode is enabled.

220

221

</ul>

222

223

224

225

<big>Font.set_italic</big> <ul>

226

enable fake rendering of italic text

227

<tt>Font.set_bold(bool): return None</tt>

228

Enables fake rendering of italic text. This is a fake skewing of the font that doesn't look good on many font types. If possible load the font from a real italic font file. While italic the font will have a different width than when normal. This can be mixed with the bold and underline modes.

229

230

</ul>

231

232

233

234

<big>Font.metrics</big> <ul>

235

Gets the metrics for each character in the pased string.

236

<tt>Font.metrics(text): return list</tt>

237

The list contains tuples for each character, which contain the minimum <tt>X</tt> offset, the maximum <tt>X</tt> offset, the minimum <tt>Y</tt> offset, the maximum <tt>Y</tt> offset and the advance offset (bearing plus width) of the character. [(minx, maxx, miny, maxy, advance), (minx, maxx, miny, maxy, advance), <tt>...]</tt>

238

239

</ul>

240

241

242

243

<big>Font.get_italic</big> <ul>

244

check if the text will be rendered italic

245

<tt>Font.get_italic(): return bool</tt>

246

Return True when the font italic rendering mode is enabled.

247

248

</ul>

249

250

251

252

<big>Font.get_linesize</big> <ul>

253

get the line space of the font text

254

<tt>Font.get_linesize(): return int</tt>

255

Return the height in pixels for a line of text with the font. When rendering multiple lines of text this is the recommended amount of space between lines.

256

257

</ul>

258

259

260

261

<big>Font.get_height</big> <ul>

262

get the height of the font

263

<tt>Font.get_height(): return int</tt>

264

Return the height in pixels of the actual rendered text. This is the average size for each glyph in the font.

265

266

</ul>

267

268

269

270

<big>Font.get_ascent</big> <ul>

271

get the ascent of the font

272

<tt>Font.get_ascent(): return int</tt>

273

Return the height in pixels for the font ascent. The ascent is the number of pixels from the font baseline to the top of the font.

274

275

</ul>

276

277

278

279

<big>Font.get_descent</big> <ul>

280

get the descent of the font

281

<tt>Font.get_descent(): return int</tt>

282

Return the height in pixels for the font descent. The descent is the number of pixels from the font baseline to the bottom of the font.

283

284

</ul>

285

</ul>

286

</ul>

287

288

</body></html>

<html>

<title>font - Pygame Documentation</title>

<tr>

<a href=http://www.pygame.org>Pygame Home</a>  ||

<a href=../index.html>Help Contents</a>  ||

<a href=index.html>Reference Index</a>  ||

<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="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="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="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>

</td></tr></table>

<big>pygame.font</big> <ul>

pygame module for loading and rendering fonts

<tr><td><a href="font.html#pygame.font.init">pygame.font.init</a> - initialize the font module</td><td>initialize the font module</td></tr>

<tr><td><a href="font.html#pygame.font.quit">pygame.font.quit</a> - uninitialize the font module</td><td>uninitialize the font module</td></tr>

<tr><td><a href="font.html#pygame.font.get_init">pygame.font.get_init</a> - true if the font module is initialized</td><td>true if the font module is initialized</td></tr>

<tr><td><a href="font.html#pygame.font.get_fonts">pygame.font.get_fonts</a> - get all available fonts</td><td>get all available fonts</td></tr>

<tr><td><a href="font.html#pygame.font.match_font">pygame.font.match_font</a> - find a specific font on the system</td><td>find a specific font on the system</td></tr>

<tr><td><a href="font.html#pygame.font.SysFont">pygame.font.SysFont</a> - create a Font object from the system fonts</td><td>create a Font object from the system fonts</td></tr>

<tr><td><a href="font.html#pygame.font.Font">pygame.font.Font</a> - create a new Font object from a file</td><td>create a new Font object from a file</td></tr>

</table></ul>

Pygame comes with a builtin default font. This can always be accessed by passing None as the font name.

<big>pygame.font.init</big> <ul>

initialize the font module

<tt>pygame.font.init(): return None</tt>

It is safe to call this function more than once.

</ul>

<big>pygame.font.quit</big> <ul>

uninitialize the font module

<tt>pygame.font.quit(): return None</tt>

Manually uninitialize SDL_ttf's font system. This is called automatically by <tt><a href="pygame.html#pygame.quit">pygame.quit</a> - uninitialize all pygame modules</tt>.

It is safe to call this function even if font is currently not initialized.

</ul>

<big>pygame.font.get_init</big> <ul>

true if the font module is initialized

<tt>pygame.font.get_init(): return bool</tt>

Test if the font module is initialized or not.

</ul>

100

101

102

103

<big>pygame.font.get_default_font</big> <ul>

104

get the filename of the default font

105

<tt>pygame.font.get_default_font(): return string</tt>

106

107

108

</ul>

109

110

111

112

<big>pygame.font.get_fonts</big> <ul>

113

get all available fonts

114

<tt>pygame.font.get_fonts(): return list of strings</tt>

115

116

117

</ul>

118

119

120

121

<big>pygame.font.match_font</big> <ul>

122

find a specific font on the system

123

<tt>pygame.font.match_font(name, bold=False, italic=False): return path</tt>

124

Returns the full path to a font file on the system. If bold or italic are set to true, this will attempt to find the correct family of font.

125

The font name can actually be a comma separated list of font names to try. If none of the given names are found, None is returned.

126

Example:

127

<pre> print pygame.font.match_font('bitstreamverasans')

128

# output is: /usr/share/fonts/truetype/ttf-bitstream-vera/Vera.ttf

129

# (but only if you have Vera on your system)

130

</pre>

131

132

</ul>

133

134

135

136

<big>pygame.font.SysFont</big> <ul>

137

create a Font object from the system fonts

138

<tt>pygame.font.SysFont(name, size, bold=False, italic=False): return Font</tt>

139

140

141

</ul>

142

143

144

145

<big>pygame.font.Font</big> <ul>

146

create a new Font object from a file

147

<tt>pygame.font.Font(filename, size): return Font</tt>

148

<tt>pygame.font.Font(object, size): return Font</tt>

149

150

<tr><td><a href="font.html#Font.render">Font.render</a> - draw text on a new Surface</td><td>draw text on a new Surface</td></tr>

151

<tr><td><a href="font.html#Font.size">Font.size</a> - determine the amount of space needed to render text</td><td>determine the amount of space needed to render text</td></tr>

152

153

154

<tr><td><a href="font.html#Font.set_bold">Font.set_bold</a> - enable fake rendering of bold text</td><td>enable fake rendering of bold text</td></tr>

155

<tr><td><a href="font.html#Font.get_bold">Font.get_bold</a> - check if text will be rendered bold</td><td>check if text will be rendered bold</td></tr>

156

<tr><td><a href="font.html#Font.set_italic">Font.set_italic</a> - enable fake rendering of italic text</td><td>enable fake rendering of italic text</td></tr>

157

158

<tr><td><a href="font.html#Font.get_italic">Font.get_italic</a> - check if the text will be rendered italic</td><td>check if the text will be rendered italic</td></tr>

159

<tr><td><a href="font.html#Font.get_linesize">Font.get_linesize</a> - get the line space of the font text</td><td>get the line space of the font text</td></tr>

160

<tr><td><a href="font.html#Font.get_height">Font.get_height</a> - get the height of the font</td><td>get the height of the font</td></tr>

161

<tr><td><a href="font.html#Font.get_ascent">Font.get_ascent</a> - get the ascent of the font</td><td>get the ascent of the font</td></tr>

162

<tr><td><a href="font.html#Font.get_descent">Font.get_descent</a> - get the descent of the font</td><td>get the descent of the font</td></tr>

163

</table></ul>

164

165

166

167

168

169

170

<big>Font.render</big> <ul>

171

draw text on a new Surface

172

<tt>Font.render(text, antialias, color, background=None): return Surface</tt>

173

174

175

176

177

178

If you render '\n' a unknown char will be rendered. Usually a rectangle. Instead you need to handle new lines yourself.

179

Font rendering is not thread safe: only a single thread can render text any time.

180

181

</ul>

182

183

184

185

186

determine the amount of space needed to render text

187

<tt>Font.size(text): return (width, height)</tt>

188

189

Be aware that most fonts use kerning which adjusts the widths for specific letter pairs. For example, the width for "ae" will not always match the width for "a" + "e".

190

191

</ul>

192

193

194

195

<big>Font.set_underline</big> <ul>

196

control if text is rendered with an underline

197

<tt>Font.set_underline(bool): return None</tt>

198

When enabled, all rendered fonts will include an underline. The underline is always one pixel thick, regardless of font size. This can be mixed with the bold and italic modes.

199

200

</ul>

201

202

203

204

<big>Font.get_underline</big> <ul>

205

check if text will be rendered with an underline

206

<tt>Font.get_underline(): return bool</tt>

207

Return True when the font underline is enabled.

208

209

</ul>

210

211

212

213

214

enable fake rendering of bold text

215

<tt>Font.set_bold(bool): return None</tt>

216

217

218

</ul>

219

220

221

222

223

check if text will be rendered bold

224

<tt>Font.get_bold(): return bool</tt>

225

Return True when the font bold rendering mode is enabled.

226

227

</ul>

228

229

230

231

<big>Font.set_italic</big> <ul>

232

enable fake rendering of italic text

233

<tt>Font.set_bold(bool): return None</tt>

234

235

236

</ul>

237

238

239

240

<big>Font.metrics</big> <ul>

241

Gets the metrics for each character in the pased string.

242

<tt>Font.metrics(text): return list</tt>

243

244

245

</ul>

246

247

248

249

<big>Font.get_italic</big> <ul>

250

check if the text will be rendered italic

251

<tt>Font.get_italic(): return bool</tt>

252

Return True when the font italic rendering mode is enabled.

253

254

</ul>

255

256

257

258

<big>Font.get_linesize</big> <ul>

259

get the line space of the font text

260

<tt>Font.get_linesize(): return int</tt>

261

Return the height in pixels for a line of text with the font. When rendering multiple lines of text this is the recommended amount of space between lines.

262

263

</ul>

264

265

266

267

<big>Font.get_height</big> <ul>

268

get the height of the font

269

<tt>Font.get_height(): return int</tt>

270

Return the height in pixels of the actual rendered text. This is the average size for each glyph in the font.

271

272

</ul>

273

274

275

276

<big>Font.get_ascent</big> <ul>

277

get the ascent of the font

278

<tt>Font.get_ascent(): return int</tt>

279

Return the height in pixels for the font ascent. The ascent is the number of pixels from the font baseline to the top of the font.

280

281

</ul>

282

283

284

285

<big>Font.get_descent</big> <ul>

286

get the descent of the font

287

<tt>Font.get_descent(): return int</tt>

288

Return the height in pixels for the font descent. The descent is the number of pixels from the font baseline to the bottom of the font.

289

290

</ul>

291

</ul>

292

</ul>

293

294

</body></html>

Older »