feat(replay): Document skipRequestAnimationFrame option for WebGPU canvas snapshots #16011
+32
−3
Conversation
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
…nvas snapshots WebGPU canvases require the skipRequestAnimationFrame option when using manual snapshotting because WebGPU textures expire after the current task completes, unlike WebGL which can use preserveDrawingBuffer. References: - WebGPU Explainer: https://gpuweb.github.io/gpuweb/explainer/ - gpuweb/gpuweb#2743: WebGPU rejected preserveDrawingBuffer by design - gpuweb/gpuweb#3295: Canvas texture expiry timing Co-Authored-By: Claude <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Collaborator
inventarSarah
left a comment
inventarSarah
left a comment
There was a problem hiding this comment.
Looks good to me overall.
Just two comments from my side -- please have a look :)
|
|
||
| WebGPU works differently from WebGL. The canvas texture returned by `getCurrentTexture()` is only valid until the current task completes - after that, the texture expires and its contents are no longer accessible. This means that by default, when `snapshot()` defers capture to the next animation frame, it will capture an empty or invalid canvas. | ||
|
|
||
| To fix this, pass `skipRequestAnimationFrame: true` to capture the snapshot immediately: |
Collaborator
There was a problem hiding this comment.
Does this also require setting enableManualSnapshot: true? If so, we could add the 2-step explanation as in the WebGL section to make sure users don't miss it.
Member
Author
There was a problem hiding this comment.
Right, yea it does. Good catch!
Co-authored-by: Sarah Mischinger <[email protected]>
Clarify that enableManualSnapshot must be set before using skipRequestAnimationFrame for WebGPU canvas snapshots. Follows the same 2-step pattern as the WebGL section to ensure users don't miss required configuration. Co-Authored-By: Claude <[email protected]>
inventarSarah
approved these changes
Jan 15, 2026
Collaborator
inventarSarah
left a comment
inventarSarah
left a comment
There was a problem hiding this comment.
👍looks great now!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds documentation for the
skipRequestAnimationFrameoption when using manual canvas snapshots with WebGPU.WebGPU textures expire after the current task completes, so deferring snapshot capture to the next animation frame results in an empty canvas. This option captures immediately after rendering.
Sources:
Related: getsentry/sentry-javascript#18804