Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved layout_engine documentation #6633

Merged
merged 3 commits into from
Oct 10, 2022
Merged

Improved layout_engine documentation #6633

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba78f5d
Document the default layout engine
radarhere Oct 2, 2022
74f47d8
Document that basic layout is faster than raqm
radarhere Oct 2, 2022
3971675
Recommend raqm for non-English text
radarhere Oct 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/PIL/ImageFont.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -945,6 +945,11 @@ def truetype(font=None, size=10, index=0, encoding="", layout_engine=None):
encoding of any text provided in subsequent operations.
:param layout_engine: Which layout engine to use, if available:
:data:`.ImageFont.Layout.BASIC` or :data:`.ImageFont.Layout.RAQM`.
If it is available, Raqm layout will be used by default.
Otherwise, basic layout will be used.

Raqm layout is recommended for all non-English text. If Raqm layout
is not required, basic layout will have better performance.

You can check support for Raqm layout using
:py:func:`PIL.features.check_feature` with ``feature="raqm"``.
Expand Down