python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-08-14 01:04:45 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document complex text layout features.

Browse Source
This commit is contained in:
shamsa 2016-02-03 14:50:46 +04:00
parent 3c3fc12480
commit 647af0d625
3 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/installation.rst
View File

@ -138,6 +138,8 @@ Many of Pillow's features require external libraries:
* Pillow does **not** support the earlier **1.5** series which ships * Pillow does **not** support the earlier **1.5** series which ships
with Ubuntu and Debian. with Ubuntu and Debian.
* **libraqm** provides complex text layout support.
Once you have installed the prerequisites, run:: Once you have installed the prerequisites, run::
$ pip install Pillow $ pip install Pillow
@ -168,14 +170,14 @@ Build Options
* Build flags: ``--disable-zlib``, ``--disable-jpeg``, * Build flags: ``--disable-zlib``, ``--disable-jpeg``,
``--disable-tiff``, ``--disable-freetype``, ``--disable-tcl``, ``--disable-tiff``, ``--disable-freetype``, ``--disable-tcl``,
``--disable-tk``, ``--disable-lcms``, ``--disable-webp``, ``--disable-tk``, ``--disable-lcms``, ``--disable-raqm``, ``--disable-webp``,
``--disable-webpmux``, ``--disable-jpeg2000``. Disable building the ``--disable-webpmux``, ``--disable-jpeg2000``. Disable building the
corresponding feature even if the development libraries are present corresponding feature even if the development libraries are present
on the building machine. on the building machine.
* Build flags: ``--enable-zlib``, ``--enable-jpeg``, * Build flags: ``--enable-zlib``, ``--enable-jpeg``,
``--enable-tiff``, ``--enable-freetype``, ``--enable-tcl``, ``--enable-tiff``, ``--enable-freetype``, ``--enable-tcl``,
``--enable-tk``, ``--enable-lcms``, ``--enable-webp``, ``--enable-tk``, ``--enable-lcms``, ``--enable-raqm``, ``--enable-webp``,
``--enable-webpmux``, ``--enable-jpeg2000``. Require that the ``--enable-webpmux``, ``--enable-jpeg2000``. Require that the
corresponding feature is built. The build will raise an exception if corresponding feature is built. The build will raise an exception if
the libraries are not found. Webpmux (WebP metadata) relies on WebP the libraries are not found. Webpmux (WebP metadata) relies on WebP

10
docs/reference/ImageDraw.rst
View File

@ -227,7 +227,7 @@ Methods
Draw a shape. Draw a shape.
.. py:method:: PIL.ImageDraw.Draw.text(xy, text, fill=None, font=None, anchor=None, spacing=0, align="left") .. py:method:: PIL.ImageDraw.Draw.text(xy, text, fill=None, font=None, anchor=None, spacing=0, align="left", direction=None, features=None)
Draws the string at the given position. Draws the string at the given position.
@ -240,9 +240,11 @@ Methods
the number of pixels between lines. the number of pixels between lines.
:param align: If the text is passed on to multiline_text(), :param align: If the text is passed on to multiline_text(),
"left", "center" or "right". "left", "center" or "right".
:param direction: Direction of the text. It can be 'rtl', 'ltr', 'ttb' or 'btt.
:param features: A list of font features used for text layout. For example, 'ligature, kerning, Medial ...etc.
.. py:method:: PIL.ImageDraw.Draw.multiline_text(xy, text, fill=None, font=None, anchor=None, spacing=0, align="left",
.. py:method:: PIL.ImageDraw.Draw.multiline_text(xy, text, fill=None, font=None, anchor=None, spacing=0, align="left") direction=None, features=[])
Draws the string at the given position. Draws the string at the given position.
@ -252,6 +254,8 @@ Methods
:param font: An :py:class:`~PIL.ImageFont.ImageFont` instance. :param font: An :py:class:`~PIL.ImageFont.ImageFont` instance.
:param spacing: The number of pixels between lines. :param spacing: The number of pixels between lines.
:param align: "left", "center" or "right". :param align: "left", "center" or "right".
:param direction: Direction of the text.
:param features: Font features used for text layout.
.. py:method:: PIL.ImageDraw.Draw.textsize(text, font=None, spacing=0) .. py:method:: PIL.ImageDraw.Draw.textsize(text, font=None, spacing=0)

4
docs/reference/ImageFont.rst
View File

@ -51,7 +51,7 @@ Methods
:return: (width, height) :return: (width, height)
.. py:method:: PIL.ImageFont.ImageFont.getmask(text, mode='') .. py:method:: PIL.ImageFont.ImageFont.getmask(text, mode='', direction=None, features=[])
Create a bitmap for the text. Create a bitmap for the text.
@ -63,6 +63,8 @@ Methods
driver prefers; if empty, the renderer may return either driver prefers; if empty, the renderer may return either
mode. Note that the mode is always a string, to simplify mode. Note that the mode is always a string, to simplify
C-level implementations. C-level implementations.
:param direction: Direction of the text.
:param features: A list of font features used for text layout.
.. versionadded:: 1.1.5 .. versionadded:: 1.1.5
:return: An internal PIL storage memory instance as defined by the :return: An internal PIL storage memory instance as defined by the