ImageFont
Module¶
The ImageFont
module defines a class with the same name. Instances of
this class store bitmap fonts, and are used with the
PIL.ImageDraw.Draw.text()
method.
PIL uses its own font file format to store bitmap fonts. You can use the pilfont utility to convert BDF and PCF font descriptors (X window font formats) to this format.
Starting with version 1.1.4, PIL can be configured to support TrueType and OpenType fonts (as well as other font formats supported by the FreeType library). For earlier versions, TrueType support is only available as part of the imToolkit package
Example¶
from PIL import ImageFont, ImageDraw
draw = ImageDraw.Draw(image)
# use a bitmap font
font = ImageFont.load("arial.pil")
draw.text((10, 10), "hello", font=font)
# use a truetype font
font = ImageFont.truetype("arial.ttf", 15)
draw.text((10, 25), "world", font=font)
Functions¶
Methods¶
-
PIL.ImageFont.ImageFont.
getsize
(text)¶ Returns: (width, height)
-
PIL.ImageFont.ImageFont.
getmask
(text, mode='', direction=None, features=[])¶ Create a bitmap for the text.
If the font uses antialiasing, the bitmap should have mode “L” and use a maximum value of 255. Otherwise, it should have mode “1”.
Parameters: - text – Text to render.
- mode –
Used by some graphics drivers to indicate what mode the driver prefers; if empty, the renderer may return either mode. Note that the mode is always a string, to simplify C-level implementations.
New in version 1.1.5.
- direction –
Direction of the text. It can be ‘rtl’ (right to left), ‘ltr’ (left to right), ‘ttb’ (top to bottom) or ‘btt’ (bottom to top). Requires libraqm.
New in version 4.2.0.
- features –
A list of OpenType font features to be used during text layout. This is usually used to turn on optional font features that are not enabled by default, for example ‘dlig’ or ‘ss01’, but can be also used to turn off default font features for example ‘-liga’ to disable ligatures or ‘-kern’ to disable kerning. To get all supported features, see https://www.microsoft.com/typography/otspec/featurelist.htm Requires libraqm.
New in version 4.2.0.
Returns: An internal PIL storage memory instance as defined by the
PIL.Image.core
interface module.