fix: Screenshot Capture#2240
Merged
bitsandfoxes merged 49 commits intomainfrom Jul 25, 2025
Merged
Conversation
|
|
||
| public void CaptureScreenshotForEvent(SentryUnityOptions options, SentryId eventId) | ||
| { | ||
| StartCoroutine(CaptureScreenshot(options, eventId)); |
Member
There was a problem hiding this comment.
This method returns before the coroutine starts/ends, right? how do we know the screenshot will be taken before the event is created?
Contributor
Author
There was a problem hiding this comment.
The ScreenshotProcessor forwards the call to the SentryMonoBehaviour that starts the coroutine for the current EndOfFrame.
bitsandfoxes
force-pushed
the
fix/screenshot-capture
branch
from
276efc3 to
11548fe
Compare
Member
|
CI is unhappy |
Closed
Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>
Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>
Contributor
Author
|
@sentry review |
![seer-by-sentry[bot]](https://avatars.githubusercontent.com/in/801464?s=60&v=4){kind=small}
bitsandfoxes
commented
Jul 24, 2025
| $BuildDir = $(GetNewProjectBuildPath) | ||
| $ApkFileName = "test.apk" | ||
| $ProcessName = "com.DefaultCompany.$(GetNewProjectName)" | ||
| $ProcessName = "io.sentry.unity.integrationtest" |
Contributor
Author
There was a problem hiding this comment.
With Unity 6 integration tests seem to fail to have their proper identifier set, causing the build to fail. We're setting this now explicitly in the Builder.cs and making use of the hardcoded name here.
bitsandfoxes
commented
Jul 24, 2025
Comment on lines
+77
to
+84
| internal virtual byte[] CaptureScreenshot(SentryUnityOptions options) | ||
| => SentryScreenshot.Capture(options); | ||
|
|
||
| internal virtual void CaptureAttachment(SentryId eventId, SentryAttachment attachment) | ||
| => (Sentry.SentrySdk.CurrentHub as Hub)?.CaptureAttachment(eventId, attachment); | ||
|
|
||
| internal virtual YieldInstruction WaitForEndOfFrame() | ||
| => new WaitForEndOfFrame(); |
Contributor
Author
There was a problem hiding this comment.
I'm making these virtual so I can create a TestScreenshotEventProcessor that overwrites these for testing purposes.
bitsandfoxes
commented
Jul 24, 2025
Comment on lines
-44
to
-51
|
|
||
| // This is a workaround for build issues with Unity 2022.3. and newer. | ||
| // https://discussions.unity.com/t/gradle-build-issues-for-android-api-sdk-35-in-unity-2022-3lts/1502187/10 | ||
| #if UNITY_2022_3_OR_NEWER | ||
| Debug.Log("Builder: Setting Android target API level to 33"); | ||
| PlayerSettings.Android.targetSdkVersion = AndroidSdkVersions.AndroidApiLevel33; | ||
| #endif | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Workaround that is no longer needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2224, #1827 🎉
Relies on the .NET SDK getsentry/sentry-dotnet#4357
Context
The SDK has to wait for
EndOfFramebefore capturing a screenshot as the behaviour is unreliable otherwise. See Unity docs.Implementation
The
ScreenshotProcessoruses theSentryMonoBehaviourto start a coroutine that waits forEnd of Frameto capture the screenshot. The screenshot gets sent as an envelop with a single attachment as envelope item.