Skip to content

docs(unity): Describe how screenshots get captured - #20340

Merged
bitsandfoxes merged 2 commits into
masterfrom
feat/unity-docs-screenshots
Oct 30, 2026
Merged

bitsandfoxes merged 2 commits into
masterfrom
feat/unity-docs-screenshots

Conversation

@bitsandfoxes

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Describes how the Unity SDK captures screenshots, for getsentry/sentry-unity#2835 and getsentry/sentry-unity#2917. Supersedes #19972.

  • Which events get a screenshot (not transactions or feedback), and where there is none (Editor, batch mode, WebGL).
  • C# capture: end of frame, shared by events captured while it's taken, background-thread events included, sent in the event's envelope, scaled by ScreenshotQuality and compressed by ScreenshotCompression.
  • Async GPU readback in the frame's own format with background encoding, and when the SDK falls back to the main thread (no readback support, SetBeforeSendScreenshot set, Nintendo Switch).
  • Native screenshots per platform: iOS only with build-time initialization, Windows on crash, none on Android, macOS, Linux.
  • Document SetBeforeSendScreenshot and ScreenshotCompression, update SetBeforeCaptureScreenshot (background thread, runs before SetBeforeSend and sampling), feedback screenshots only with addScreenshot, and the troubleshooting entry.

Should be merged together with the sentry-unity 4.12.0 release.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

🤖 Generated with Claude Code

Explain which events get a screenshot, that it's taken at the end of
the frame and sent in the event's envelope, shared by events captured
while it's taken, and read back asynchronously in the frame's own
format unless SetBeforeSendScreenshot is set
(getsentry/sentry-unity#2835, getsentry/sentry-unity#2917). List
native screenshots per platform, document SetBeforeSendScreenshot and
ScreenshotCompression, and that feedback screenshots are only taken
on request.

Supersedes #19972.
@vercel

vercel Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 30, 2026 10:08am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 30, 2026 10:08am UTC

Request Review

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 30, 2026 10:03
@bitsandfoxes
bitsandfoxes marked this pull request as ready for review October 30, 2026 11:48
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 30, 2026 11:48
@bitsandfoxes
bitsandfoxes merged commit 3b7bf0d into master Oct 30, 2026
29 checks passed
@bitsandfoxes
bitsandfoxes deleted the feat/unity-docs-screenshots branch October 30, 2026 14:14

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — f2b53c8b Deployed Oct 30, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants