Pillow/docs/reference/ImageGrab.rst

49 lines
1.8 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)
===================================================
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
2019-12-09 17:55:15 +03:00
.. 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
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.
2020-02-15 07:35:12 +03:00
.. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS), 7.1.0 (Linux (X11))
:param bbox: What region to copy. Default is the entire screen.
2019-09-20 18:35:08 +03:00
Note that on Windows OS, the top-left point may be negative if ``all_screens=True`` is used.
:param include_layered_windows: Includes layered windows. Windows OS only.
2019-09-27 01:58:32 +03:00
.. versionadded:: 6.1.0
2019-09-20 18:35:08 +03:00
:param all_screens: Capture all monitors. Windows OS only.
2019-09-27 01:58:32 +03:00
.. versionadded:: 6.2.0
2019-12-09 17:55:15 +03:00
:param xdisplay: X11 Display address. Pass ``None`` to grab the default system screen.
Pass ``""`` to grab the default X11 screen on Windows or macOS.
2020-02-15 07:35:12 +03:00
.. versionadded:: 7.1.0
: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.