docs(camera): clarify screenshot camera param behavior and UI capture limitation

[sssooonnnggg]

Clarify screenshot camera param behavior and UI capture limitation

Corrects misleading "Defaults to Camera.main" in the camera parameter description

and adds explicit warnings that specifying a camera excludes Screen Space - Overlay

canvases from the capture.

Summary by Sourcery

Clarify screenshot capture behavior and camera parameter effects in the camera management tooling documentation.

Documentation:

• Update screenshot command description to explain default ScreenCapture behavior versus camera-based rendering and their impact on UI capture.
• Clarify camera parameter docs to note it no longer defaults to Camera.main and that specifying a camera excludes Screen Space - Overlay UI canvases from captures.

Summary by CodeRabbit

• Documentation
  • Clarified screenshot capture behavior: default operation now captures all render layers including Screen Space Overlay UI. When a specific camera is designated, Screen Space Overlay canvases are excluded from the camera-rendered capture.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates camera screenshot tool documentation to correct default camera behavior and clearly explain the difference between ScreenCapture-based screenshots and camera-rendered captures, especially regarding Screen Space - Overlay UI visibility.

Flow diagram for screenshot capture mode based on camera parameter

flowchart TD
  Start["Call screenshot tool"] --> Decision["Is camera parameter specified?"]
  Decision -->|"No (camera omitted)"| ScreenCapture["Use ScreenCapture API"]
  ScreenCapture --> UIIncluded["Capture all render layers including Screen Space - Overlay UI canvases"]
  UIIncluded --> End["Return screenshot (optionally as base64 PNG if include_image=true)"]

  Decision -->|"Yes (camera specified)"| CameraRender["Use direct camera rendering"]
  CameraRender --> UIExcluded["Exclude Screen Space - Overlay canvases from capture"]
  UIExcluded --> Viewpoint["Capture from specified camera viewpoint"]
  Viewpoint --> End

Loading

File-Level Changes

Change	Details	Files
Clarify screenshot command help text to describe default ScreenCapture behavior and UI capture vs camera rendering tradeoffs.	Update the screenshot command description to state that, with no camera specified, screenshots use the ScreenCapture API and include all render layers including Screen Space - Overlay canvases. Explain that when a camera is explicitly specified, the implementation uses direct camera rendering, which excludes Screen Space - Overlay canvases and should be used only when a specific viewpoint is needed. Keep existing notes about include_image, batch modes, view_target/view_position, and capture_source while integrating the new explanation into the help string.	Server/src/services/tools/manage_camera.py
Correct and expand the camera parameter docstring to reflect actual default behavior and UI exclusion when a camera is provided.	Remove the misleading note that the camera parameter defaults to Camera.main. Document that omitting the camera parameter uses the ScreenCapture API and captures all layers including Screen Space - Overlay UI. Add an explicit warning that specifying a camera will not capture Screen Space - Overlay canvases and should be used only when a particular camera viewpoint is required.	Server/src/services/tools/manage_camera.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e2cccbcd-c13e-4d41-96db-c3f801e04664

📥 Commits

Reviewing files that changed from the base of the PR and between 2b547fa and b83470b.

📒 Files selected for processing (1)

• Server/src/services/tools/manage_camera.py

---

📝 Walkthrough

Walkthrough

Documentation update to the manage_camera tool clarifying the behavior difference between the two camera capture modes: omitting the camera parameter uses ScreenCapture API capturing all render layers including Screen Space Overlay UI, while specifying a camera uses direct rendering excluding overlays.

Changes

Cohort / File(s)	Summary
Camera Capture Documentation Server/src/services/tools/manage_camera.py	Updated camera parameter help text to clarify behavior: omitting the parameter defaults to ScreenCapture API (includes all layers with overlay UI), while specifying a camera uses direct rendering (excludes Screen Space Overlay canvases).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

📸 A camera's path, now crystal clear,
Omit to see all—overlays appear!
Specify one for a focused view,
Overlays fade, as the direct rays break through.
Documentation blooms, confusion takes flight. 🐰✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The PR description covers the main objectives and changes. However, it lacks explicit sections matching the repository's template structure, particularly missing a clear 'Type of Change' section and formal 'Changes Made' list.	Structure the description using the template sections: add explicit 'Type of Change' (Documentation update), 'Changes Made' with bullet points, and confirm 'Documentation Updates' checklist completion.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: documentation updates clarifying screenshot camera parameter behavior and UI capture limitations.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}