Scene Viewport Snapshot
scene_viewport_snapshotCapture the active viewport as an image to verify what the artist sees, including HUD and selection highlights. Only works in GUI sessions; headless sessions get an error.
Instructions
Capture the active viewport as an image (WYSIWYG).
GUI sessions only - headless (mayapy/batch/native-channel) sessions get a structured gui_session_required error.
The capture is what the artist sees: viewport HUD, selection highlights and ornaments included. That is a feature - the agent verifies exactly what the user is looking at. A cmds.refresh(force=True) runs first so the frame is current.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | "jpeg" (default, small) or "png". png recommended for wireframe/line-art review. | jpeg |
| quality | No | JPEG quality 1-100 (ignored for png). | |
| max_size | No | Longest-side pixel cap for the returned image (default 800 - keeps base64 well under client image token limits). | |
| session_key | No | Maya session key. |