dosbox_capture_screen
Capture the exact current DOSBox-X frame and save it as PNG/RGB plus an optional data-segment dump, making the same instant replayable as a fixture.
Instructions
Capture the current frame exactly and save it: .rgb (one byte per pixel), .png, and with with_segment also _ds.bin, the data segment from the same instant -- which is what makes a captured frame replayable as a fixture.
source='vram' reads the frame out of the emulator's video memory, which is exact, cheap, cannot catch a half-drawn frame and does not slow the guest. source='window' photographs the window instead, resizing it to an integer multiple of the guest resolution; that is the one visible effect this server has on the desktop, and it costs the guest real time. 'auto' takes video memory when the page has been CONFIRMED against a reference and falls back to the window otherwise, so it never quietly saves the wrong 64,000 bytes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pid | No | ||
| stem | Yes | Output path without a suffix; relative to DOSBOX_MCP_OUTPUT_DIR. | |
| exact | No | Require every pixel to be a palette colour. | |
| scale | No | Window scale to capture at, for source='window'. | |
| source | No | auto | |
| reference | No | Path to a 64,000-byte frame on screen now; confirms a vram capture. | |
| with_segment | No | Also dump the data segment from the same instant. | |
| settle_seconds | No | Wait for the window to finish resizing. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||