Skip to main content

Robust multi-monitor screenshot grabber (Windows-only right now)

Project description

Desktopmagic
============
Desktopmagic takes screenshots on Windows. It supports any
arrangement of multiple monitors, and does not leak memory in any
failure mode (locked workstation, no monitor attached, etc). If you wish,
it can be used continuously to take millions of screenshots.

You may want this instead of PIL's ImageGrab because:

* Desktopmagic can take a screenshot of all monitors. You can:

* Take a screenshot of the entire virtual screen.

* Take a screenshot of the entire virtual screen, split into separate PIL Images.

* Take a screenshot of just one display.

* Take a screenshot of an arbitrary region of the virtual screen.

(See below for usage)

* ImageGrab leaks memory if you try to take a screenshot when the
workstation is locked (as of 2011-01).



Requirements
============
* Python 2.6, 2.7, or 3.3+

* pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/

* PIL or Pillow, unless you don't need
`getScreenAsImage`, `getDisplaysAsImages`, or `getRectAsImage`.

* PIL: http://www.pythonware.com/products/pil/

* Pillow: https://pypi.python.org/pypi/Pillow/



Installation
============
```
pip install Desktopmagic
```

or:

```
git clone https://github.com/ludios/Desktopmagic
cd Desktopmagic
pip install .
```

or without pip:

```
python setup.py install
```

This installs the module `desktopmagic` and the script `screengrab_torture_test`.



Examples
========
```py
from __future__ import print_function

from desktopmagic.screengrab_win32 import (
getDisplayRects, saveScreenToBmp, saveRectToBmp, getScreenAsImage,
getRectAsImage, getDisplaysAsImages)

# Save the entire virtual screen as a BMP (no PIL required)
saveScreenToBmp('screencapture_entire.bmp')

# Save an arbitrary rectangle of the virtual screen as a BMP (no PIL required)
saveRectToBmp('screencapture_256_256.bmp', rect=(0, 0, 256, 256))

# Save the entire virtual screen as a PNG
entireScreen = getScreenAsImage()
entireScreen.save('screencapture_entire.png', format='png')

# Get bounding rectangles for all displays, in display order
print("Display rects are:", getDisplayRects())
# -> something like [(0, 0, 1280, 1024), (-1280, 0, 0, 1024), (1280, -176, 3200, 1024)]

# Capture an arbitrary rectangle of the virtual screen: (left, top, right, bottom)
rect256 = getRectAsImage((0, 0, 256, 256))
rect256.save('screencapture_256_256.png', format='png')

# Unsynchronized capture, one display at a time.
# If you need all displays, use getDisplaysAsImages() instead.
for displayNumber, rect in enumerate(getDisplayRects(), 1):
imDisplay = getRectAsImage(rect)
imDisplay.save('screencapture_unsync_display_%d.png' % (displayNumber,), format='png')

# Synchronized capture, entire virtual screen at once, cropped to one Image per display.
for displayNumber, im in enumerate(getDisplaysAsImages(), 1):
im.save('screencapture_sync_display_%d.png' % (displayNumber,), format='png')
```

For more information, see the docstrings in https://github.com/ludios/Desktopmagic/blob/master/desktopmagic/screengrab_win32.py



Wishlist
========
* OS X support

* Linux support



Contributing
============
Patches and pull requests are welcome.

This coding standard applies: http://ludios.org/coding-standard/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

Desktopmagic-14.3.11.zip (12.4 kB view details)

Uploaded Source

Desktopmagic-14.3.11.tar.gz (8.9 kB view details)

Uploaded Source

File details

Details for the file Desktopmagic-14.3.11.zip.

File metadata

  • Download URL: Desktopmagic-14.3.11.zip
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Desktopmagic-14.3.11.zip
Algorithm Hash digest
SHA256 7c741982ae235a6b44ba327b0bde87d0977b8c340fa790b2380a2f9c7edfa787
MD5 070708b4978ccf14a8424a141f0309a4
BLAKE2b-256 44d3f68428c318a213f1c77d11ea001b341cd659e973e80abc4d3739adca9714

See more details on using hashes here.

File details

Details for the file Desktopmagic-14.3.11.tar.gz.

File metadata

File hashes

Hashes for Desktopmagic-14.3.11.tar.gz
Algorithm Hash digest
SHA256 83a798da95d5f0458943c175ec891a29e530ae6131c92414054229c0fae21dad
MD5 bdbc0719ab6655dc7be88484fbccd2f6
BLAKE2b-256 b95cf2e5b406fbe38cb8c60c5dd79da893a6c50de680882e68a2ad6a3c97e36d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page