Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add screenshot feature description for Unreal Engine #11042

Merged
merged 7 commits into from
Sep 11, 2024

Conversation

tustanivsky
Copy link
Collaborator

@tustanivsky tustanivsky commented Aug 9, 2024

This PR adds screenshot capturing feature description for Unreal Engine SDK.

Copy link

vercel bot commented Aug 9, 2024

@tustanivsky is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Aug 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 10, 2024 9:46pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 10, 2024 9:46pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Sep 10, 2024 9:46pm

@bruno-garcia
Copy link
Member

Looks OK to me but you might want @lizokm's review

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few comments, but otherwise this looks good. Thanks for adding!

@tustanivsky
Copy link
Collaborator Author

Thank you, I've updated the PR according to the above suggestions.

@bruno-garcia bruno-garcia enabled auto-merge (squash) August 14, 2024 13:37
Copy link
Member

@bruno-garcia bruno-garcia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Ivan

@bruno-garcia
Copy link
Member

I've already approved the Vercel build but seems stuck. cc @lizokm any tips?

@tustanivsky
Copy link
Collaborator Author

Do you happen to have any updates on this? I suppose we should be ready to proceed with the merge

@vivianyentran
Copy link
Contributor

Hi there, the docs team is focusing on other priorities at the moment, so it may take us another week or more to get to this PR. If you need us to review this sooner, please let us know so we can prioritize accordingly. Thanks for your patience!

Since the Unreal Engine SDK consists of multiple SDKs, the specific mechanism with which a screenshot is captured will vary depending on where the error originated.

- On Windows/Linux, errors from within your game will be captured using the Unreal Engine API. This means that screenshots will only contain what's visible within your game. Any overlays on top of your game won't be visible.
- On Apple/Android, screenshots will be captured using platform APIs. If you're using a native plugin to display an overlay and an error occurs, the SDK will try to capture a screenshot that contains the overlay.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could clarify that it's still limited to the actual game app and not "anything that's an overlay on the screen".

auto-merge was automatically disabled September 3, 2024 14:53

Pull request was closed

@bitsandfoxes bitsandfoxes reopened this Sep 3, 2024
Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@tustanivsky tustanivsky merged commit 3daab70 into getsentry:master Sep 11, 2024
10 checks passed
@tustanivsky tustanivsky deleted the feat/unreal-engine branch September 11, 2024 06:20
@github-actions github-actions bot locked and limited conversation to collaborators Sep 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants