Skip to content

Commit eb024d8

Browse files
authored
Merge pull request #1060 from sssooonnnggg/beta
docs(camera): clarify screenshot camera param behavior and UI capture limitation
2 parents 2b547fa + b83470b commit eb024d8

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

Server/src/services/tools/manage_camera.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,11 @@
6161
"- release_override: Release camera override\n"
6262
"- list_cameras: List all cameras with status\n\n"
6363
"CAPTURE:\n"
64-
"- screenshot: Capture from a camera. Supports include_image=true for inline base64 PNG, "
64+
"- screenshot: Capture a screenshot. By default (no camera specified) uses ScreenCapture API, "
65+
"which captures all render layers including Screen Space - Overlay UI canvases. "
66+
"Specifying a camera uses direct camera rendering, which EXCLUDES Screen Space - Overlay canvases "
67+
"(use only when you need a specific viewpoint without UI). "
68+
"Supports include_image=true for inline base64 PNG, "
6569
"batch='surround' for 6-angle contact sheet, batch='orbit' for configurable grid, "
6670
"view_target/view_position for positioned capture, and capture_source='scene_view' to capture "
6771
"the active Unity Scene View viewport.\n"
@@ -90,7 +94,10 @@ async def manage_camera(
9094
screenshot_super_size: Annotated[int | str | None,
9195
"Screenshot supersize multiplier (integer >= 1)."] = None,
9296
camera: Annotated[str | None,
93-
"Camera to capture from (name, path, or instance ID). Defaults to Camera.main."] = None,
97+
"Camera to capture from (name, path, or instance ID). "
98+
"Omit to use ScreenCapture API (captures all layers including Screen Space Overlay UI). "
99+
"Specify only when you need a particular camera viewpoint; note that Screen Space - Overlay "
100+
"canvases will NOT appear in camera-rendered captures."] = None,
94101
include_image: Annotated[bool | str | None,
95102
"If true, return screenshot as inline base64 PNG. Default false."] = None,
96103
max_resolution: Annotated[int | str | None,

0 commit comments

Comments
 (0)