Updated documentation now that Linux is supported

This commit is contained in:
Andrew Murray 2020-05-03 13:06:25 +10:00
parent d23df7227c
commit 6669ffd053
2 changed files with 5 additions and 7 deletions

View File

@ -1,20 +1,18 @@
.. py:module:: PIL.ImageGrab .. py:module:: PIL.ImageGrab
.. py:currentmodule:: PIL.ImageGrab .. py:currentmodule:: PIL.ImageGrab
:py:mod:`ImageGrab` Module (macOS and Windows only) :py:mod:`ImageGrab` Module
=================================================== ==========================
The :py:mod:`ImageGrab` module can be used to copy the contents of the screen The :py:mod:`ImageGrab` module can be used to copy the contents of the screen
or the clipboard to a PIL image memory. or the clipboard to a PIL image memory.
.. note:: The current version works on macOS and Windows only.
.. versionadded:: 1.1.3 .. versionadded:: 1.1.3
.. py:function:: PIL.ImageGrab.grab(bbox=None, include_layered_windows=False, all_screens=False, xdisplay=None) .. py:function:: PIL.ImageGrab.grab(bbox=None, include_layered_windows=False, all_screens=False, xdisplay=None)
Take a snapshot of the screen. The pixels inside the bounding box are Take a snapshot of the screen. The pixels inside the bounding box are
returned as an "RGB" image on Windows or "RGBA" on macOS. returned as an "RGBA" on macOS, or an "RGB" image otherwise.
If the bounding box is omitted, the entire screen is copied. If the bounding box is omitted, the entire screen is copied.
.. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS), 7.1.0 (Linux (X11)) .. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS), 7.1.0 (Linux (X11))
@ -36,7 +34,7 @@ or the clipboard to a PIL image memory.
.. py:function:: PIL.ImageGrab.grabclipboard() .. py:function:: PIL.ImageGrab.grabclipboard()
Take a snapshot of the clipboard image, if any. Take a snapshot of the clipboard image, if any. Only macOS and Windows are currently supported.
.. versionadded:: 1.1.4 (Windows), 3.3.0 (macOS) .. versionadded:: 1.1.4 (Windows), 3.3.0 (macOS)

View File

@ -2,7 +2,7 @@
# The Python Imaging Library # The Python Imaging Library
# $Id$ # $Id$
# #
# screen grabber (macOS and Windows only) # screen grabber
# #
# History: # History:
# 2001-04-26 fl created # 2001-04-26 fl created