For a new Wayland client, start with ext-image-copy-capture-v1, then confirm that the compositor on the target machine advertises it. The protocol is still in testing/staging, not a universal stable screenshot command. A client binds the compositor’s manager, selects an image source such as an output or toplevel, follows the advertised buffer constraints, submits a buffer, and waits asynchronously for ready or failed.
The older wlr-screencopy-unstable-v1 remains useful for compatibility, but its own documentation marks it experimental and deprecated and recommends the newer protocol.
Choose the protocol before writing capture code
Wayland does not define one shell command that every desktop uses for screenshots. Capture is a protocol between your client and a compositor, and support depends on the compositor build, release, advertised globals, and the way it exposes capture sources.
| Protocol | Current role | What it can capture | Important qualification |
|---|---|---|---|
ext-image-copy-capture-v1 |
Preferred starting point for new clients | Image sources such as outputs and toplevels, copied into client buffers | Documentation describes it as testing/staging; support varies by compositor |
wlr-screencopy-unstable-v1 |
Legacy compatibility path | An entire output or a region in output logical coordinates | Documented as experimental and deprecated; use only when target support requires it |
The protocol documentation lists implementations including Sway 1.11, Labwc 0.20.2, and Mir 2.26. Those entries are useful compatibility clues, not a guarantee that a distribution package or local configuration enables the protocol. Inspect the actual compositor’s globals and version at runtime.
Recommended Free Tools
#1 Best Overall
- Powerful Linux Laptop: This IdeaPad Slim 3 Laptop comes pre-installed with Ubuntu Linux, offering fast performance, robust security, and a clean, user-friendly experience. Enjoy full customization, seamless hardware compatibility, and access to thousands of open-source apps. Whether you're working, creating, or coding, it's built to keep up with everything you do.
- A Multitasking Master: The latest AMD Ryzen 7 5825U processor (up to 4.5 GHz) delivers powerful performance with 8 cores and 16 threads for smooth multitasking. Integrated AMD Radeon Graphics provide crisp visuals for streaming, browsing, photo editing, and casual gaming. With smart machine intelligence, it adapts to your needs for a fast, responsive experience.
- 15.6" Full HD Display: The IdeaPad Slim 3 boasts an 88% screen-to-body ratio for a floating, edge-to-edge visual experience. TÜV Low Blue Light certification reduces eye strain, making it perfect for long work or study sessions.
- Military-Grade Durability: The smart IdeaPad Slim 3 combines portability and durability, letting you work, study, and play on the go. With a profile 10% slimmer than the previous generation, it's lightweight yet military-grade rugged, ready for anything, anywhere.
- Versatile Connectivity: Enjoy the security of a built-in webcam with a privacy shutter. Connect effortlessly with multiple ports: 2x USB A, 1x USB C, 1x HDMI, 1x SD Card Reader, 1x Headphone/Microphone combo. Bundle comes with Stylus Pen, 256GB Portable SSD and 5-in-1 Docking Station.
What the newer capture lifecycle does
1. Discover and bind the manager
Enumerate the Wayland globals announced by the compositor. If ext-image-copy-capture-v1 is not advertised, do not send requests for it: choose a supported fallback or report that the compositor cannot provide this capture path. Bind the advertised image-copy-capture manager at the version your client understands.
2. Obtain an image source
Use the relevant source protocol/API to identify what you want to capture. Depending on compositor support, that may be an output or a toplevel. Keep source selection separate from buffer allocation so your code can reject an unavailable source cleanly.
3. Create a capture session and choose cursor behavior
Create a session for the selected source. The manager provides an option to paint cursors into captured frames. Select that option when the pointer should be composited; when it is not selected, the cursor must not be composited. Do not assume a default cursor policy.
4. Wait for buffer constraints
Listen for the compositor’s constraint events. It reports a supported shared-memory and/or DMA-BUF format and modifier combinations, the required buffer size, and a done event that ends the current constraint batch. Constraints can be sent again later if the source or compositor changes.
Allocate a buffer that matches the reported size and one of the advertised format paths. A shared-memory buffer is often the simplest CPU-readable route; DMA-BUF may be appropriate when your application already imports GPU buffers. The protocol does not let you choose an arbitrary format just because your image library accepts it.
Rank #2
- Intel Core i5-10210U (up to 4.2GHz) - 1TB PCIe NVMe + 1TB HDD - 32GB DDR4 SDRAM
- 17.3" HD+ (1600x900) Display, Intel UHD Graphics 620
- Built in HD 720p Webcam with Microphone - Bluetooth Version4.2
- I/O Ports: 2x USB 3.1 (Data Only), 1x USB 2.0, 1x HDMI, 1x Headphone/Microphone Combo Jack
- Linux Mint Cinnamon 64-Bit - 6-Row Keyboard w/ Full Numberpad
5. Describe damage, attach, and capture
Create a frame object, attach the matching buffer, and describe the changed regions when you track damage. For a first capture, or whenever damage is unknown, damage the entire buffer. Send capture only after a buffer is attached; the request may be sent once for that frame.
6. Process completion events
A successful frame supplies its metadata before emitting ready. Read the buffer only after completion, then encode or display it in your application. A failed operation emits failed; treat that as a capture failure rather than consuming undefined pixels.
Destroy the completed frame before requesting another frame in the same session. Only one frame object may exist per session at a time. After the first successful frame, the compositor may wait indefinitely for source content to change before copying another frame, so an ongoing session is not equivalent to a loop of immediately available one-shot screenshots.
Implementing a client without assuming a universal command
The wire protocol is generated from Wayland XML and normally used through language bindings rather than handwritten byte messages. A robust implementation therefore has three layers:
- Discovery: enumerate globals, bind the manager, and select a source only when the required global and source API exist.
- Resource setup: create the session, set the cursor option, collect constraints until
done, and allocate a matching shared-memory or DMA-BUF buffer. - Frame state: create one frame, attach and damage the buffer, issue
capture, dispatch events untilreadyorfailed, destroy the frame, and repeat only after destruction.
Keep the event loop running while a frame is pending. A synchronous call that waits for a reply without dispatching Wayland events can deadlock. Also handle a second constraint batch by reallocating or renegotiating the buffer before the next frame.
Rank #3
- Intel Core i5-1335U Processor (12M Cache, 12 Threads, up to 4.6 GHz) - 256GB Solid State Drive - 16GB DDR4 SDRAM
- 15.6" FHD (1920x1080) Non-Touch Anti-Glare Display - Intel UHD 620 Integrated Graphics - Stereo Speakers
- 720p HD Webcam with Privacy Shutter. Integrated Microphone - Intel Dual Band Wireless-AC (2x2) 8265, Bluetooth Version 4.2
- I/O Ports: 2x USB 3.0, 1x USB 3.1 Type-C 3.1, Headphone/Mic Combo Port, 4-in-1 Card Reader, HDMI, Kensington Mini-Lock Slot
- Linux Mint (Cinnamon) 64-Bit - Keyboard with Full NumberPad - Fast Charging
Output and toplevel capture decisions
Capture an output
Choose an output when you need the compositor’s complete display surface. The resulting dimensions and format come from the compositor’s constraints, not from a hard-coded monitor size. If the output changes mode or scale, expect constraints to be updated.
Capture a toplevel
Choose a toplevel when the compositor and source-selection API expose an individual window. Availability and identification are compositor-dependent; do not assume every desktop permits arbitrary-window capture.
Do these 3 things before closing this tab:
1Fix the driver behind crashes, sound loss and screen glitches2Clear out junk files and repair common Windows errors3Scan for outdated or missing drivers - takes under a minuteChoose shared memory or DMA-BUF
- Shared memory: straightforward for a CPU encoder or PNG writer, provided the compositor advertises a compatible format.
- DMA-BUF: useful for zero-copy or GPU pipelines, but requires handling the advertised modifier and import details correctly.
Using the legacy wlr protocol when necessary
If the target compositor does not expose ext-image-copy-capture-v1 but does expose wlr-screencopy-unstable-v1, use the legacy path as a compatibility branch. It supports an entire output or a region expressed in output logical coordinates. Keep this code isolated so the newer protocol remains the default for environments that support it. Because the legacy documentation calls it experimental and deprecated, avoid presenting it as a long-term protocol choice.
Compatibility checklist
- Query the compositor’s advertised globals at runtime.
- Record the advertised protocol version and the distribution’s compositor build.
- Verify that the desired source (output or toplevel) can be obtained.
- Confirm that at least one advertised format/modifier path can be allocated by your client.
- Test cursor-on and cursor-off behavior explicitly.
- Exercise a source change and verify that repeated frames arrive only after the source changes.
- Test the failure path and release the frame object before retrying.
Troubleshooting common failures
The manager is missing
Symptom: no image-copy-capture global appears. Cause: the compositor release, build, or configuration does not provide the protocol. Fix: inspect advertised globals on that exact session, update or configure the compositor if appropriate, or use the legacy protocol only when it is available and required.
No usable buffer format
Symptom: constraints arrive, but your allocator cannot create a matching buffer. Cause: the client selected an unsupported format, modifier, or size. Fix: negotiate from the reported list, implement a shared-memory fallback where advertised, or add DMA-BUF modifier support.
Rank #4
The frame never becomes ready
Symptom: the event loop remains alive but no completion arrives. Cause: after an initial frame, the compositor can wait for source content to change. Fix: treat the session as change-driven; continue dispatching events, or destroy and recreate the session only when your application’s policy permits it.
Capture fails after a retry
Symptom: a new capture request is rejected. Cause: the previous frame object still exists, or a frame received more than one capture request. Fix: process ready or failed, destroy that frame, then create exactly one new frame for the next request.
The cursor is unexpectedly absent or present
Cause: cursor composition is an explicit session option. Fix: set the option deliberately and verify the resulting pixels in both modes.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Performance, reliability, and security considerations
Damage tracking can reduce copying when only part of a source changes, but whole-buffer damage is the correct conservative choice when you do not track damage. Reuse an allocated buffer when constraints remain identical, while still honoring any new constraint batch. Keep encoding outside the Wayland dispatch callback when possible so slow disk or image work does not stall protocol events.
For continuous capture, design back-pressure: do not create a second frame while one is outstanding, and decide whether to drop, coalesce, or queue application-level work after ready. For one-shot screenshots, remember that “capture” still completes asynchronously and can fail.
Quick wins for a faster PC:
Clear out junk files and repair common Windows errorsFree Scan →Scan for outdated or missing drivers - takes under a minuteDriver Scan →Best Value
- 12th Intel Alder Lake N95 Processor – The GMKtec G3 S Mini PC is powered by the 12th Gen Intel N95 processor with 4 cores, 4 threads, 6MB cache and a burst frequency up to 3.4GHz. Compared with N100/N5105/N5100/N5095, the N95 delivers up to 36% overall performance improvement. Perfect for routine tasks, office work, and home entertainment, this compact mini desktop is more convenient than traditional bulky PCs.
- 8GB RAM & 256GB SSD Storage – Pre-installed with 8GB DDR4 memory and a fast 256GB M.2 2242 SSD, the G3 S mini desktop offers quicker startup, smoother multitasking, and faster file transfers. Enjoy seamless performance whether you’re working on multiple applications, browsing, or streaming content.
- Rich Interfaces & Connectivity – The G3 S mini computer comes equipped with USB 3.2 (up to 10Gbps), dual HDMI 2.0 (4K@60Hz), and a 3.5mm audio jack. With support for WiFi 5, Bluetooth 5.0, and Gigabit Ethernet (RJ45 1000MbE), it connects easily with monitors, projectors, printers, office equipment, and other peripherals, making it versatile for both home and business use.
- Dual 4K Display Support – Featuring upgraded Intel UHD Graphics (up to 1000MHz), the G3 S supports 4K video playback and AV1 decoding for a smooth viewing experience. With dual HDMI outputs, you can connect two 4K@60Hz displays simultaneously, enabling efficient multitasking for work and entertainment.
- GMKtec WARRANTY - GMKtec offers a 1-year limited GMKtec's warranty for each mini PC, starting from the date of the purchase. All defects due to design and workmanship are covered. With a professional after sales team always ready to attend to your needs, you can simply relax and enjoy your mini PC.
Or skip the browser setup
If your goal is a screenshot of a web page rather than a Wayland surface, ScreenshotNeo provides a one-request website screenshot API. It is not a replacement for compositor capture, but it avoids launching and coordinating a browser on your machine.
cURL:
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webpPython:
import requests
r = requests.get("https://api.screenshotneo.com/v1/shot", params={"access_key": "YOUR_API_KEY", "url": "https://stripe.com"}, timeout=90)
open("shot.webp", "wb").write(r.content)Node.js:
const q = new URLSearchParams({ access_key: 'YOUR_API_KEY', url: 'https://stripe.com' });
const res = await fetch(`https://api.screenshotneo.com/v1/shot?${q}`);See the ScreenshotNeo API documentation for response details and options. Before capture, it can accept cookie/consent banners and remove more than 60 known consent platforms, newsletter popups, and chat widgets; each cleanup step can be disabled. Bot checks or CAPTCHAs, blank pages, timeouts, failed loads, and cache hits are not billed as clean shots, and response headers identify the page verdict and billing status. Its MCP server exposes take_screenshot, get_page_info, and capture_pdf for Claude, Cursor, and other MCP clients.
| Plan | Allowance | Price |
|---|---|---|
| Free | 1,000 shots/month | No card required |
| Starter | 3,000 shots | $5 |
| Growth | 15,000 shots | $15 |
| Pro | 60,000 shots | $39 |
| Scale | 250,000 shots | $99 |
| Business | 1,000,000 shots | $249 |
Every feature is on every plan, and yearly billing gives two months free. Create a free ScreenshotNeo account to get 1,000 screenshots a month with no card.
Frequently Asked Questions
Is ext-image-copy-capture-v1 available on every Wayland desktop?
No. It is still described as testing/staging, and availability depends on the compositor release, build, configuration, and advertised globals on the active session.
PC Slower Than It Used to Be?
A free scan shows the junk files, broken settings and background clutter dragging Windows down - then fixes them in one click.Free scan · Windows 10 & 11Outdated Drivers Are Slowing You Down
One free scan finds every outdated or missing driver and matches the right update for your exact hardware.Free scan · exact hardware matchCan I request several frames at once?
No. The lifecycle permits only one frame object per capture session. Complete and destroy it before creating the next frame.
Does a successful capture always arrive immediately?
No. After the first successful frame, the compositor may wait until source content changes before producing another frame.
What should a client do when the protocol is unavailable?
Report the missing capability or use a separately implemented compatibility branch for wlr-screencopy-unstable-v1 when the target compositor provides it.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
Free tools Windows power users keep installed
One-click scans. No signup required.
