Source

pygame-draw / docs / _sources / ref / freetype.txt

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
.. include:: common.txt

:mod:`pygame.freetype`
======================

.. module:: pygame.freetype
   :synopsis: Enhanced Pygame module for loading and rendering font faces

| :sl:`Enhanced Pygame module for loading and rendering font faces`

--- Note that some features may change before a formal release

This module allows for rendering all face formats supported by FreeType, namely
``TTF``, Type1, ``CFF``, OpenType, ``SFNT``, ``PCF``, ``FNT``, ``BDF``, ``PFR``
and Type42 faces. It can render any UTF-32 character in a font file.

This module is optional, and replaces all of the functionality of the original
'font' module, whilst expanding it. This module depends in no way on the
SDL_ttf library.

You should test that :mod:`pygame.freetype` is initialized before attempting to
use the module; if the module is available and loaded, it will be automatically
initialized by ``pygame.init()``

Most of the work done with faces is done by using the actual Face objects. The
module by itself only has routines to initialize itself and create Face objects
with ``pygame.freetype.Face()``.

You can load faces from the system by using the ``pygame.freetype.SysFont()``
function. There are a few other functions to help lookup the system fonts.

For now undefined character codes are replaced with the ``undefined character``.
How undefined codes are handled may become configurable in a future release.

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

New in Pygame 1.9.2

.. function:: get_error

   | :sl:`Get the latest error`
   | :sg:`get_error() -> str`

   Returns the description of the last error which occurred in the FreeType
   library, or None if no errors have occurred.

.. function:: get_version

   | :sl:`Get the FreeType version`
   | :sg:`get_version() -> (int, int, int)`

   Gets the version of the FreeType2 library which was used to build the
   'freetype' module.

   Note that the FreeType module depends on the FreeType 2 library, and will
   not compile with the original FreeType 1.0, hence the first element of the
   tuple will always be 2.

.. function:: init

   | :sl:`Initialize the underlying FreeType 2 library.`
   | :sg:`init(cache_size=64, resolution=72) -> None`

   This function initializes the underlying FreeType 2 library and must be
   called before trying to use any of the functionality of the 'freetype'
   module.

   However, if the module is available, this function will be automatically
   called by ``pygame.init()``. It is safe to call this function more than
   once.

   Optionally, you may specify a default size for the Glyph cache: this is the
   maximum amount 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
   be given to adjust face scaling.

.. function:: quit

   | :sl:`Shuts down the underlying FreeType 2 library.`
   | :sg:`quit() -> None`

   This function de-initializes the 'freetype' module. After calling this
   function, you should not invoke any class, method or function related to the
   'freetype' module as they are likely to fail or might give unpredictable
   results. It is safe to call this function even if the module hasn't been
   initialized yet.

.. function:: was_init

   | :sl:`Returns whether the the FreeType 2 library is initialized.`
   | :sg:`was_init() -> bool`

   Returns whether the the FreeType 2 library is initialized.

.. function:: get_default_resolution

   | :sl:`Return the default pixel size in dots per inch`
   | :sg:`get_default_resolution() -> long`

   Returns the default pixel size, in dots per inch for the module. At
   initial module load time the value is 72.

.. function:: set_default_resolution

   | :sl:`Set the default pixel size in dots per inch for the module`
   | :sg:`set_default_resolution([resolution]) -> None`

   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.

.. function:: get_default_font

   | :sl:`Get the filename of the default font`
   | :sg:`get_default_font() -> string`

   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.

.. class:: Face

   | :sl:`Creates a new Face instance from a supported font file.`
   | :sg:`Face(file, style=STYLE_NONE, ptsize=-1, face_index=0, vertical=0, ucs4=0, resolution=0) -> Face`

   'file' can be either a string representing the font's filename, a file-like
   object containing the font, or None; in this last case the default, built-in
   font will be used.

   Optionally, a \*ptsize* argument may be specified to set the default size in
   points which will be used to render the face. Such size can also be
   specified manually on each method call. Because of the way the caching
   system works, specifying a default size on the constructor doesn't imply a
   performance gain over manually passing the size on each function call.

   If the font file has more than one face, the \*index* argument may be
   specified to specify which face index to load. Defaults to 0; face loading
   will fail if the given index is not contained in the font.

   The 'style' argument will set the default style (oblique, underline, strong)
   used to draw this face. This style may be overriden on any ``Face.render()``
   call.

   The optional vertical argument, an integer, sets the default orientation
   for the face: 0 (False) for horizontal, any other value (True) for vertical.
   See :attr:`Face.vertical`.

   The optional ucs4 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
   :attr:`Face.ucs4`.

   The optional resolution argument sets the pixel size, in dots per inch,
   to use for scaling glyphs for this Face instance. If 0 then the default
   module value, set by :meth:`freetype.init`, is used. The Face object's
   resolution can only be changed by reinitializing the instance.

   .. attribute:: name

      | :sl:`Gets the name of the font face.`
      | :sg:`name -> string`

      Read only. Returns the real (long) name of the font type face, as
      specified on the font file.

   .. attribute:: path

      | :sl:`Gets the path of the font file`
      | :sg:`path -> unicode`

      Read only. Returns the path of the loaded font file

   .. method:: get_rect

      | :sl:`Gets the size and offset of rendered text`
      | :sg:`get_rect(text, style=STYLE_DEFAULT, rotation=0, ptsize=default) -> rect`

      Gets the final dimensions and origin, in pixels, of 'text' 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 face object.

      Returns a rect containing the width and height of the text's bounding
      box and the position of the text'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.

      If text is a char (byte) string, then its encoding is assumed to be
      ``LATIN1``.

   .. method:: get_metrics

      | :sl:`Gets glyph metrics for the face's characters`
      | :sg:`get_metrics(text, ptsize=default) -> [(...), ...]`

      Returns the glyph metrics for each character in 'text'.

      The glyph metrics are returned inside a list; each character will be
      represented as a tuple inside the list with the following values:

      ::

          (min_x, max_x, min_y, max_y, horizontal_advance_x, horizontal_advance_y)

      The bounding box min_x, max_y, min_y, and max_y values are returned as
      grid-fitted pixel coordinates of type int. The advance values are 
      float values.

      The calculations are done using the face's default size in points.
      Optionally you may specify another point size to use.

      The metrics are adjusted for the current rotation, strong, and oblique
      settings.

      If text is a char (byte) string, then its encoding is assumed to be
      ``LATIN1``.

   .. attribute:: height

      | :sl:`Gets the unscaled height of the face in font units`
      | :sg:`height -> int`

      Read only. Gets the height of the face. This is the average value of all
      glyphs in the face.

   .. method:: ascender

      | :sl:`get the unscaled ascent of the face in font units`
      | :sg:`ascender -> int`

      Read only. Return the number of units from the face's baseline to
      the top of the bounding box.

   .. attribute:: descender

      | :sl:`get the unscaled descent of the face in font units`
      | :sg:`descender -> int`

      Read only. Return the height in font units for the face descent.
      The descent is the number of units from the face's baseline to the
      bottom of the bounding box.

   .. attribute:: get_sized_ascender

      | :sl:`Gets the scaled ascent the face in pixels`
      | :sg:`get_sized_ascender() -> int`

      Return the number of units from the face's baseline to the top of the
      bounding box. It is not adjusted for strong or rotation.

   .. method:: get_sized_descender

      | :sl:`Gets the scaled descent the face in pixels`
      | :sg:`get_sized_descender() -> int`

      Return the number of pixels from the face's baseline to the top of the
      bounding box. It is not adjusted for strong or rotation.

   .. attribute:: get_sized_height

      | :sl:`Gets the scaled height of the face in pixels`
      | :sg:`get_sized_height() -> int`

      Read only. Gets the height of the face. This is the average value of all
      glyphs in the face. It is not adjusted for strong or rotation.

   .. method:: get_sized_glyph_height

      | :sl:`Gets the scaled height of the face in pixels`
      | :sg:`get_sized_glyph_height() -> int`

      Return the glyph bounding box height of the face in pixels.
      This is the average value of all glyphs in the face.
      It is not adjusted for strong or rotation.

   .. method:: render

      | :sl:`Renders text on a surface`
      | :sg:`render(text, fgcolor, bgcolor=None, style=STYLE_DEFAULT, rotation=0, ptsize=default) -> (Surface, Rect)`

      Renturns a new :mod:`pygame.Surface`, with the text rendered to it
      in the color given by 'fgcolor'. If ``bgcolor`` 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
      surface has a 32 bit pixel size. However, if ``bgcolor`` is ``None``
      and antialiasing is disabled a two color 8 bit surface with colorkey
      set for the background color is returned.

      The return value is a tuple: the new surface and the bounding
      rectangle giving the size and origin of the rendered text.

      If an empty string is passed for text then the returned Rect is zero
      width and the height of the face. If dest is None the returned surface is
      the same dimensions as the boundary rect. The rect will test False.

      The rendering is done using the face's default size in points and its
      default style, without any rotation, and taking into account faces which
      are set to be drawn vertically via the :meth:`Face.vertical` attribute.
      Optionally you may specify another point size to use via the 'ptsize'
      argument, a text rotation via the 'rotation' argument, or a new text
      style via the 'style' argument.

      If text is a char (byte) string, then its encoding is assumed to be
      ``LATIN1``.

   .. method:: render_to

      | :sl:`Renders text to an existing surface`
      | :sg:`render(surf, dest, text, fgcolor, bgcolor=None, style=STYLE_DEFAULT, rotation=0, ptsize=default) -> Rect`

      Renders the string 'text' to a :mod:`pygame.Surface` 'surf',
      using the color 'fgcolor'.

      Argument 'dest' 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 Rect, for which the first two elements are
      positions x and y is accepted.

      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.

      The return value is a rectangle giving the size and position of the
      rendered text within the surface.

      If an empty string is passed for text then the returned Rect is zero
      width and the height of the face. The rect will test False.

      By default, the point size and style set for the face are used
      if not passed as arguments. The text is unrotated unless a non-zero
      rotation value is given.

      If text is a char (byte) string, then its encoding is assumed to be
      ``LATIN1``.

   .. method:: render_raw

      | :sl:`Renders text as a string of bytes`
      | :sg:`render_raw(text, style=STYLE_DEFAULT, rotation=0, ptsize=default, invert=False) -> (bytes, (int, int))`

      Like ``Face.render()`` but the tuple returned is an 8 bit
      monochrome string of bytes and its size. The forground color is 255, the
      background 0, useful as an alpha mask for a foreground pattern.

   .. method:: render_raw_to

      | :sl:`Renders text as a string of ints to an array`
      | :sg:`render_raw_to(array, text, dest=None, style=STYLE_DEFAULT, rotation=0, ptsize=default, invert=False) -> (int, int)`

      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).

   .. attribute:: style

      | :sl:`Gets or sets the face's style`
      | :sg:`style -> int`

      Gets or sets the default style of the Face. This default style will be
      used for all text rendering and size calculations unless overriden
      specifically in the \`render()` or \`get_size()` calls. The style value
      may be a bitwise ``OR`` of one or more of the following constants:

      ::

          STYLE_NONE
          STYLE_UNDERLINE
          STYLE_OBLIQUE
          STYLE_STRONG
	  STYLE_WIDE

      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).

   .. attribute:: underline

      | :sl:`Gets or sets the face's underline style`
      | :sg:`underline -> bool`

      Gets or sets whether the face will be underlined when drawing text. This
      default style value will be used for all text rendering and size
      calculations unless overriden specifically in the \`render()` or
      \`get_size()` calls, via the 'style' parameter.

   .. attribute:: strong

      | :sl:`Gets or sets the face's strong style`
      | :sg:`strong -> bool`

      Gets or sets whether the face will be bold when drawing text. This
      default style value will be used for all text rendering and size
      calculations unless overriden specifically in the \`render()` or
      \`get_size()` calls, via the 'style' parameter.

   .. attribute:: oblique

      | :sl:`Gets or sets the face's oblique style`
      | :sg:`oblique -> bool`

      Gets or sets whether the face will be rendered as oblique. This
      default style value will be used for all text rendering and size
      calculations unless overriden specifically in the \`render()` or
      \`get_size()` calls, via the 'style' parameter.

   .. attribute:: wide

      | :sl:`Gets or sets the face's wide style`
      | :sg:`wide -> bool`

      Gets or sets whether the face will be stretched horizontally
      when drawing text. It produces a result simular to font.Font's
      bold. This style is only available for unrotated text.

   .. attribute:: strength

      | :sl:`Gets or sets the strength of the strong or wide styles`
      | :sg:`strength -> float`

      The amount by which a face glyph's size is enlarged for the
      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.

   .. attribute:: underline_adjustment

      | :sl:`Gets or sets an adjustment factor for the underline position`
      | :sg:`underline_adjustment -> float`

      Gets or sets a factor which, when positive, is multiplied with the
      face's underline offset to adjust the underline position. A negative
      value turns an underline into a strikethrough or overline. It is
      multiplied with the ascender. Accepted values are between -2.0 and 2.0
      inclusive. A value of 0.5 closely matches Tango underlining. A value of
      1.0 mimics SDL_ttf.

   .. attribute:: fixed_width

      | :sl:`Gets whether the face is fixed-width`
      | :sg:`fixed_width -> bool`

      Read only. Returns whether this Face is a fixed-width (bitmap) face.

      Note that scalable faces whose glyphs are all the same width (i.e.
      monospace ``TTF`` fonts used for programming) are not considered fixed
      width.

   .. attribute:: antialiased

      | :sl:`Face antialiasing mode`
      | :sg:`antialiased -> bool`

      Gets or sets the face's antialiasing mode. This defaults to ``True`` on
      all faces, which are rendered with full 8 bit blending.

      Setting this to ``False`` will enable monochrome rendering. This should
      provide a small speed gain and reduce cache memory size.

   .. attribute:: kerning

      | :sl:`Character kerning mode`
      | :sg:`kerning -> bool`

      Gets or sets the face's kerning mode. This defaults to False on all
      faces, which will be rendered by default without kerning.

      Setting this to true will change all rendering methods to do kerning
      between character pairs for surface size calculation and all
      render operations.

   .. attribute:: vertical

      | :sl:`Face vertical mode`
      | :sg:`vertical -> bool`

      Gets or sets whether the face is a vertical face such as faces in fonts
      representing Kanji glyphs or other styles of vertical writing.

      Changing this attribute will cause the face to be rendering vertically,
      and affects all other methods which manage glyphs or text layouts to use
      vertical metrics accordingly.

      Note that the FreeType library doesn't automatically detect whether a
      face contains glyphs which are always supposed to be drawn vertically, so
      this attribute must be set manually by the user.

      Also note that several face formats (specially bitmap based ones) don't
      contain the necessary metrics to draw glyphs vertically, so drawing in
      those cases will give unspecified results.

   .. attribute:: origin

      | :sl:`Face render to text origin mode`
      | :sg:`vertical -> bool`

      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.

   .. attribute:: pad

      | :sl:`padded boundary mode`
      | :sg:`pad -> bool`

      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.

   .. attribute:: ucs4

      | :sl:`Enables UCS-4 mode`
      | :sg:`ucs4 -> bool`

      Gets or sets the decoding of Unicode textdecoding. By default, the
      freetype module performs UTF-16 surrogate pair decoding on Unicode text.
      This allows 32-bit escape sequences ('\Uxxxxxxxx') between 0x10000 and
      0x10FFFF to represent their corresponding UTF-32 code points on Python
      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.

   .. attribute:: resolution

      | :sl:`Output pixel resolution in dots per inch`
      | :sg:`resolution -> int`

      Gets the pixel size used in scaling face glyphs for this Face instance.

   .. method:: set_transform

      | :sl:`assign a glyph transformation matrix`
      | :sg:`set_transform(xx, xy, yx, yy) -> None`

      Set a transform matrix for the face. If None, no matrix assigned.
      The arguments can be any numeric type that can be converted
      to a double. The matrix is applied after the strong transformation,
      but before oblique and rotation.

   .. method:: delete_transform

      | :sl:`delete a glyph transformation matrix`
      | :sg:`set_transform(xx, xy, yx, yy) -> None`

      Remove the transformation matrix, if any.

   .. method:: get_transform

      | :sl:`return the user assigned transformation matrix, or None`
      | :sg:`get_transform() -> (double, double, double, double) or None`

      Return the transform matrix for the face. If None, no matrix is assigned.
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.