-
-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add AttachScreenshot option * feat: capture screenshots * refactor: throw in ScreenshotAttachmentContent.GetStream() * test: screenshot integration test * wip: screenshot capture options * feat: Screenshot resizing * fix: windows integration test must enable AttachScreenshot * chore: update changelog * fix: handle non-main thread screenshot attachment explicitly * chore: editor UI changes * chore: ScreenshotAttachment: minor refactoring * chore: fix webgl test script after screenshot attachment * test: SmokeTest - check for 0-byte attachments * chore: disable screenshot capture on WebGL Co-authored-by: Bruno Garcia <bruno@brunogarcia.com> Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io>
- Loading branch information
3 people
committed
Apr 21, 2022
1 parent
c346531
commit d49cf66
Showing
17 changed files
with
263 additions
and
24 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| using System; | ||
| using System.IO; | ||
| using Sentry; | ||
| using Sentry.Extensibility; | ||
| using Sentry.Unity.Integrations; | ||
| using UnityEngine; | ||
| using UnityEngine.Rendering; | ||
|
|
||
| namespace Sentry.Unity | ||
| { | ||
| internal class ScreenshotAttachment : Attachment | ||
| { | ||
| public ScreenshotAttachment(IAttachmentContent content) | ||
| : base(AttachmentType.Default, content, "screenshot.jpg", "image/jpeg") { } | ||
| } | ||
|
|
||
| internal class ScreenshotAttachmentContent : IAttachmentContent | ||
| { | ||
| private readonly SentryMonoBehaviour _behaviour; | ||
| private readonly SentryUnityOptions _options; | ||
|
|
||
| public ScreenshotAttachmentContent(SentryUnityOptions options, SentryMonoBehaviour behaviour) | ||
| { | ||
| _behaviour = behaviour; | ||
| _options = options; | ||
| } | ||
|
|
||
| public Stream GetStream() | ||
| { | ||
| // Note: we need to check explicitly that we're on the same thread. While Unity would throw otherwise | ||
| // when capturing the screenshot, it would only do so on development builds. On release, it just crashes... | ||
| if (!_behaviour.MainThreadData.IsMainThread()) | ||
| { | ||
| _options.DiagnosticLogger?.LogDebug("Won't capture screenshot because we're not on the main thread"); | ||
| // Throwing here to avoid empty attachment being sent to Sentry. | ||
| // return new MemoryStream(); | ||
| throw new Exception("Sentry: cannot capture screenshot attachment on other than the main (UI) thread."); | ||
| } | ||
|
|
||
| return new MemoryStream(CaptureScreenshot()); | ||
| } | ||
|
|
||
| private byte[] CaptureScreenshot() | ||
| { | ||
| // Calculate the desired size by calculating the ratio between the desired height/width and the actual one, | ||
| // and than resizing based on the smaller of the two ratios. | ||
| var width = Screen.width; | ||
| var height = Screen.height; | ||
| var ratioW = _options.ScreenshotMaxWidth <= 0 ? 1.0f : (float)_options.ScreenshotMaxWidth / (float)width; | ||
| var ratioH = _options.ScreenshotMaxHeight <= 0 ? 1.0f : (float)_options.ScreenshotMaxHeight / (float)height; | ||
| var ratio = Mathf.Min(ratioH, ratioW); | ||
| if (ratio > 0.0f && ratio < 1.0f) | ||
| { | ||
| width = Mathf.FloorToInt((float)width * ratio); | ||
| height = Mathf.FloorToInt((float)height * ratio); | ||
| } | ||
|
|
||
| // Captures the current screenshot synchronously. | ||
| var screenshot = new Texture2D(width, height, TextureFormat.RGB24, false); | ||
| var rtFull = RenderTexture.GetTemporary(Screen.width, Screen.height); | ||
| ScreenCapture.CaptureScreenshotIntoRenderTexture(rtFull); | ||
| var rtResized = RenderTexture.GetTemporary(width, height); | ||
| // On all (currently supported) platforms except Android, the image is mirrored horizontally & vertically. | ||
| // So we must mirror it back. | ||
| if (ApplicationAdapter.Instance.Platform == RuntimePlatform.Android) | ||
| { | ||
| Graphics.Blit(rtFull, rtResized); | ||
| } | ||
| else | ||
| { | ||
| Graphics.Blit(rtFull, rtResized, new Vector2(1, -1), new Vector2(0, 1)); | ||
| } | ||
| RenderTexture.ReleaseTemporary(rtFull); | ||
|
|
||
| // Remember the previous render target and change it to our target texture. | ||
| var previousRT = RenderTexture.active; | ||
| RenderTexture.active = rtResized; | ||
|
|
||
| try | ||
| { | ||
| // actually copy from the current render target a texture & read data from the active RenderTexture | ||
| screenshot.ReadPixels(new Rect(0, 0, width, height), 0, 0); | ||
| screenshot.Apply(); | ||
| } | ||
| finally | ||
| { | ||
| // Restore the render target. | ||
| RenderTexture.active = previousRT; | ||
| } | ||
|
|
||
| var bytes = screenshot.EncodeToJPG(_options.ScreenshotQuality); | ||
| _options.DiagnosticLogger?.Log(SentryLevel.Debug, | ||
| "Screenshot captured at {0}x{1}: {0} bytes", null, width, height, bytes.Length); | ||
| return bytes; | ||
| } | ||
| } | ||
| } |
This file contains 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
This file contains 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
Oops, something went wrong.