mirror of
https://github.com/python-pillow/Pillow.git
synced 2025-10-28 14:41:07 +03:00
78 lines
2.9 KiB
ReStructuredText
78 lines
2.9 KiB
ReStructuredText
.. py:module:: PIL.ImageGrab
|
|
.. py:currentmodule:: PIL.ImageGrab
|
|
|
|
:py:mod:`~PIL.ImageGrab` module
|
|
===============================
|
|
|
|
The :py:mod:`~PIL.ImageGrab` module can be used to copy the contents of the screen
|
|
or the clipboard to a PIL image memory.
|
|
|
|
.. versionadded:: 1.1.3
|
|
|
|
.. py:function:: grab(bbox=None, include_layered_windows=False, all_screens=False, xdisplay=None, window=None, scale_down=False)
|
|
|
|
Take a snapshot of the screen. The pixels inside the bounding box are returned as
|
|
"RGBA" on macOS, or "RGB" image otherwise. If the bounding box is omitted,
|
|
the entire screen is copied.
|
|
|
|
On macOS, it will be at 2x if on a Retina screen. If this is not desired, pass
|
|
``scale_down=True``.
|
|
|
|
On Linux, if ``xdisplay`` is ``None`` and the default X11 display does not return
|
|
a snapshot of the screen, ``gnome-screenshot``, ``grim`` or ``spectacle`` will be
|
|
used as a fallback if they are installed. To disable this behaviour, pass
|
|
``xdisplay=""`` instead.
|
|
|
|
.. versionadded:: 1.1.3 Windows support
|
|
.. versionadded:: 3.0.0 macOS support
|
|
.. versionadded:: 7.1.0 Linux support
|
|
|
|
:param bbox: What region to copy. Default is the entire screen.
|
|
On macOS, this is increased to 2x for Retina screens, so the full
|
|
width of a Retina screen would be 2880, not 1440.
|
|
On Windows, the top-left point may be negative if ``all_screens=True``
|
|
is used.
|
|
:param include_layered_windows: Includes layered windows. Windows OS only.
|
|
|
|
.. versionadded:: 6.1.0
|
|
:param all_screens: Capture all monitors. Windows OS only.
|
|
|
|
.. versionadded:: 6.2.0
|
|
|
|
:param xdisplay:
|
|
X11 Display address. Pass :data:`None` to grab the default system screen. Pass ``""`` to grab the default X11 screen on Windows or macOS.
|
|
|
|
You can check X11 support using :py:func:`PIL.features.check_feature` with ``feature="xcb"``.
|
|
|
|
.. versionadded:: 7.1.0
|
|
|
|
:param window:
|
|
HWND, to capture a single window. Windows only.
|
|
|
|
.. versionadded:: 11.2.1
|
|
|
|
:param scale_down: On macOS, Retina screens will provide images at 2x size by default. This will prevent that, and scale down to 1x.
|
|
Keyword-only argument.
|
|
|
|
.. versionadded:: 12.1.0
|
|
:return: An image
|
|
|
|
.. py:function:: grabclipboard()
|
|
|
|
Take a snapshot of the clipboard image, if any.
|
|
|
|
On Linux, ``wl-paste`` or ``xclip`` is required.
|
|
|
|
.. versionadded:: 1.1.4 Windows support
|
|
.. versionadded:: 3.3.0 macOS support
|
|
.. versionadded:: 9.4.0 Linux support
|
|
|
|
: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.
|
|
|
|
On Linux, an image.
|