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.ImageDraw.text()
method.
PIL uses its own font file format to store bitmap fonts, limited to 256 characters. You can use pilfont.py from pillow-scripts 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.
Warning
To protect against potential DOS attacks when using arbitrary strings as
text input, Pillow will raise a ValueError
if the number of characters
is over a certain limit, MAX_STRING_LENGTH
.
This threshold can be changed by setting
MAX_STRING_LENGTH
. It can be disabled by setting
ImageFont.MAX_STRING_LENGTH = None
.
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#
Constants#
- PIL.ImageFont.Layout.BASIC#
Use basic text layout for TrueType font. Advanced features such as text direction are not supported.
- PIL.ImageFont.Layout.RAQM#
Use Raqm text layout for TrueType font. Advanced features are supported.
Requires Raqm, you can check support using
PIL.features.check_feature()
withfeature="raqm"
.
Constants#
- PIL.ImageFont.MAX_STRING_LENGTH#
Set to 1,000,000, to protect against potential DOS attacks. Pillow will raise a
ValueError
if the number of characters is over this limit. The check can be disabled by settingImageFont.MAX_STRING_LENGTH = None
.