Updated return values to match ImageFont

This commit is contained in:
Andrew Murray 2022-09-03 21:09:44 +10:00
parent 7966c344ac
commit 4783ecf41c

View File

@ -489,7 +489,7 @@ Methods
.. versionadded:: 6.2.0
:returns: A ``(width, height)`` tuple.
:return: (width, height)
.. py:method:: ImageDraw.multiline_textsize(text, font=None, spacing=4, direction=None, features=None, language=None, stroke_width=0)
@ -543,7 +543,7 @@ Methods
.. versionadded:: 6.2.0
:returns: A ``(width, height)`` tuple.
:return: (width, height)
.. py:method:: ImageDraw.textlength(text, font=None, direction=None, features=None, language=None, embedded_color=False)
@ -612,7 +612,7 @@ Methods
It should be a `BCP 47 language code`_.
Requires libraqm.
:param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX).
:returns: A single float, the length of the text.
:return: Width for horizontal, height for vertical text.
.. py:method:: ImageDraw.textbbox(xy, text, font=None, anchor=None, spacing=4, align="left", direction=None, features=None, language=None, stroke_width=0, embedded_color=False)
@ -662,8 +662,7 @@ Methods
Requires libraqm.
:param stroke_width: The width of the text stroke.
:param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX).
:returns: An ``(x0, y0, x1, y1)`` tuple, describing the top left and lower right
corners of the text.
:return: ``(left, top, right, bottom)`` bounding box
.. py:method:: ImageDraw.multiline_textbbox(xy, text, font=None, anchor=None, spacing=4, align="left", direction=None, features=None, language=None, stroke_width=0, embedded_color=False)
@ -707,8 +706,7 @@ Methods
Requires libraqm.
:param stroke_width: The width of the text stroke.
:param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX).
:returns: An ``(x0, y0, x1, y1)`` tuple, describing the top left and lower right
corners of the text.
:return: ``(left, top, right, bottom)`` bounding box
.. py:method:: getdraw(im=None, hints=None)