Pillow/docs/reference/ImageGrab.rst

37 lines
1.2 KiB
ReStructuredText
Raw Normal View History

2013-10-13 04:22:02 +04:00
.. py:module:: PIL.ImageGrab
.. py:currentmodule:: PIL.ImageGrab
2016-09-23 14:12:03 +03:00
:py:mod:`ImageGrab` Module (macOS and Windows only)
2015-12-02 07:40:16 +03: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.
2016-09-23 14:12:03 +03:00
.. note:: The current version works on macOS and Windows only.
2013-10-13 04:22:02 +04:00
.. versionadded:: 1.1.3
.. py:function:: PIL.ImageGrab.grab(bbox=None)
Take a snapshot of the screen. The pixels inside the bounding box are
2016-09-23 14:12:03 +03:00
returned as an "RGB" image on Windows or "RGBA" on macOS.
If the bounding box is omitted, the entire screen is copied.
2016-09-23 14:12:03 +03:00
.. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS)
: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.
2016-09-23 14:12:03 +03:00
.. versionadded:: 1.1.4 (Windows), 3.3.0 (macOS)
: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, an image,
or None if the clipboard does not contain image data.