Skip to main content

Installing

pip install WinAPIClient

Usage

Common usage

# select the currently active window
winapi = WinAPIClient()
# alternatively select another window by title:
winapi = WinAPIClient(wnd_title="Untitled - Notepad")
#   or by manually acquired window handle:
winapi = WinAPIClient(hwnd=0xC0FFEE)

# make selected window top-level, enable transparency, and make click-through
winapi.init_overlay()
# same as:
winapi = WinAPIClient(init_overlay=True)

Manually set overlay settings

# initiate layered mode (allows windows to use transparency)
# Note: layered mode will make a window click-through
winapi.set_layered_mode()

# enable transparency (sets style-flags required for transparency)
# Note: after transparency is enabled, any pixel in the window matching
#   the color "winapi.color_key" will be transparent
winapi.set_transparency(opacity=1, color_key=None)

# make the window always top-level (appearing in front of other windows)
winapi.set_always_toplevel()

Other methods

# make entire window transparent (not just the color_key)
winapi.set_transparency(.5)

# reset the window style to default
winapi.reset_style(retain_size=False, retain_pos=False)

Release files for WinAPIClient 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for WinAPIClient 0.1.0
File Size Uploaded
WinAPIClient-0.1.0.tar.gz 4.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for WinAPIClient 0.1.0
File Interpreter ABI Platform
WinAPIClient-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.0 kB

Release files / WinAPIClient-0.1.0.tar.gz

Download URL WinAPIClient-0.1.0.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
72b0b168073f2a1d320798b95824243582e59a650ee3d15971dac6638c38ed7e
BLAKE2b-256 checksum
How to use checksums
c9dd2f11bf556aabbae43ee4ee30a90904f01edb7db82c2d2c24f469ea9a1404
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

Release files / WinAPIClient-0.1.0-py3-none-any.whl

Download URL WinAPIClient-0.1.0-py3-none-any.whl
Size 5.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bf848bd809ebb2d7d9bfa3eeb4223778d661e67c1678471e7871e8a8e40a170d
BLAKE2b-256 checksum
How to use checksums
34b3bbc27afb36f657fa000d658f3313f2d09231d215d3736974df17c2c30668
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page