From a05c2cf7ff99b41574d2266e2ec50eaa471618ae Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Sun, 16 Jul 2017 15:22:46 +1000 Subject: [PATCH] Improved ImageDraw documentation --- PIL/ImageDraw.py | 11 +++++++---- docs/reference/ImageDraw.rst | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 4 deletions(-) diff --git a/PIL/ImageDraw.py b/PIL/ImageDraw.py index 7b8fa6cf5..89df27338 100644 --- a/PIL/ImageDraw.py +++ b/PIL/ImageDraw.py @@ -87,7 +87,10 @@ class ImageDraw(object): self.font = None def getfont(self): - """Get the current default font.""" + """ + Get the current default font. + + :returns: An image font.""" if not self.font: # FIXME: should add a font repository 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, 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 + :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. """ @@ -375,7 +378,7 @@ def floodfill(image, xy, value, border=None, thresh=0): newedge.append((s, t)) edge = newedge - + def _color_diff(rgb1, rgb2): """ Uses 1-norm distance to calculate difference between two rgb values. diff --git a/docs/reference/ImageDraw.rst b/docs/reference/ImageDraw.rst index 4eee0fd20..ea55dd75f 100644 --- a/docs/reference/ImageDraw.rst +++ b/docs/reference/ImageDraw.rst @@ -121,6 +121,12 @@ Functions 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) Draws an arc (a portion of a circle outline) between the start and end @@ -348,3 +354,32 @@ Methods Requires libraqm. .. 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.