2013-10-13 04:22:02 +04:00
|
|
|
.. py:module:: PIL.ImageGrab
|
|
|
|
|
.. py:currentmodule:: PIL.ImageGrab
|
|
|
|
|
|
2015-08-01 10:44:13 +03:00
|
|
|
:py:mod:`ImageGrab` Module (OS X and Windows only)
|
2013-10-13 09:17:45 +04:00
|
|
|
=========================================
|
2013-10-13 04:22:02 +04:00
|
|
|
|
|
|
|
|
The :py:mod:`ImageGrab` module can be used to copy the contents of the screen
|
|
|
|
|
or the clipboard to a PIL image memory.
|
|
|
|
|
|
2015-09-28 15:34:44 +03:00
|
|
|
.. note:: The current version works on OS X and Windows only. OS X support was added in 3.0.0.
|
2013-10-13 04:22:02 +04:00
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.3
|
|
|
|
|
|
2013-10-13 20:56:33 +04:00
|
|
|
.. py:function:: PIL.ImageGrab.grab(bbox=None)
|
|
|
|
|
|
|
|
|
|
Take a snapshot of the screen. The pixels inside the bounding box are
|
2015-08-01 10:44:13 +03:00
|
|
|
returned as an "RGB" image on Windows or "RGBA" on OS X.
|
|
|
|
|
If the bounding box is omitted, the entire screen is copied.
|
2013-10-13 20:56:33 +04:00
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.3
|
|
|
|
|
|
|
|
|
|
:param bbox: What region to copy. Default is the entire screen.
|
|
|
|
|
:return: An image
|
|
|
|
|
|
|
|
|
|
.. py:function:: PIL.ImageGrab.grabclipboard()
|
|
|
|
|
|
|
|
|
|
Take a snapshot of the clipboard image, if any.
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.4
|
|
|
|
|
|
2015-08-01 10:44:13 +03:00
|
|
|
:return: On Windows, an image, a list of filenames,
|
|
|
|
|
or None if the clipboard does not contain image data or filenames.
|
|
|
|
|
Note that if a list is returned, the filenames may not represent image files.
|
|
|
|
|
|
|
|
|
|
On Mac, this is not currently supported.
|
