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

Improved ImageDraw documentation

Browse Source
This commit is contained in:
Andrew Murray 2017-07-16 15:22:46 +10:00
parent f33976f81d
commit a05c2cf7ff
2 changed files with 42 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
PIL/ImageDraw.py
View File

@ -87,7 +87,10 @@ class ImageDraw(object):
self.font = None self.font = None
def getfont(self): def getfont(self):
"""Get the current default font.""" """
Get the current default font.
:returns: An image font."""
if not self.font: if not self.font:
# FIXME: should add a font repository # FIXME: should add a font repository
from . import ImageFont from . import ImageFont
@ -330,8 +333,8 @@ def floodfill(image, xy, value, border=None, thresh=0):
pixels with a color different from the border color. If not given, pixels with a color different from the border color. If not given,
the region consists of pixels having the same color as the seed the region consists of pixels having the same color as the seed
pixel. pixel.
:param thresh: Optional threshold value which specifies a maximum :param thresh: Optional threshold value which specifies a maximum
tolerable difference of a pixel value from the 'background' in tolerable difference of a pixel value from the 'background' in
order for it to be replaced. Useful for filling regions of non- order for it to be replaced. Useful for filling regions of non-
homogeneous, but similar, colors. homogeneous, but similar, colors.
""" """
@ -375,7 +378,7 @@ def floodfill(image, xy, value, border=None, thresh=0):
newedge.append((s, t)) newedge.append((s, t))
edge = newedge edge = newedge
def _color_diff(rgb1, rgb2): def _color_diff(rgb1, rgb2):
""" """
Uses 1-norm distance to calculate difference between two rgb values. Uses 1-norm distance to calculate difference between two rgb values.

35
docs/reference/ImageDraw.rst
View File

@ -121,6 +121,12 @@ Functions
Methods Methods
------- -------
.. py:method:: PIL.ImageDraw.ImageDraw.getfont()
Get the current default font.
:returns: An image font.
.. py:method:: PIL.ImageDraw.ImageDraw.arc(xy, start, end, fill=None) .. py:method:: PIL.ImageDraw.ImageDraw.arc(xy, start, end, fill=None)
Draws an arc (a portion of a circle outline) between the start and end Draws an arc (a portion of a circle outline) between the start and end
@ -348,3 +354,32 @@ Methods
Requires libraqm. Requires libraqm.
.. versionadded:: 4.2.0 .. versionadded:: 4.2.0
.. py:method:: PIL.ImageDraw.getdraw(im=None, hints=None)
.. warning:: This method is experimental.
A more advanced 2D drawing interface for PIL images,
based on the WCK interface.
:param im: The image to draw in.
:param hints: An optional list of hints.
:returns: A (drawing context, drawing resource factory) tuple.
.. py:method:: PIL.ImageDraw.floodfill(image, xy, value, border=None, thresh=0)
.. warning:: This method is experimental.
Fills a bounded region with a given color.
:param image: Target image.
:param xy: Seed position (a 2-item coordinate tuple).
:param value: Fill color.
:param border: Optional border value. If given, the region consists of
pixels with a color different from the border color. If not given,
the region consists of pixels having the same color as the seed
pixel.
:param thresh: Optional threshold value which specifies a maximum
tolerable difference of a pixel value from the 'background' in
order for it to be replaced. Useful for filling regions of non-
homogeneous, but similar, colors.