Add usage notes to OffscreenCanvas.transferToImageBitmap. #28019
Conversation
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
Some web developers have noted that transferToImageBitmap can be confusing and lead to application bugs; crbug.com/1457212 is one recent example. Add a section describing the necessity to either consume or close the ImageBitmap this API creates, and mention an alternative.
|
Preview URLs (comment last updated: 2023-07-20 22:23:34) |
Josh-Cena
reviewed
Jul 18, 2023
Thanks for the suggestion - have moved the new text there. Added a mention in the top-level docs, since people skimming just |
kenrussell
changed the title
|
@Josh-Cena @sideshowbarker would you be able to (re-)review this? We received feedback from a web developer that they'd like these clarifications. Thanks. |
sideshowbarker
approved these changes
Jul 20, 2023
sideshowbarker
approved these changes
Jul 20, 2023
files/en-us/web/api/offscreencanvas/transfertoimagebitmap/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/offscreencanvas/transfertoimagebitmap/index.md
Outdated
Show resolved
Hide resolved
|
Thank you! |
|
Cheers — it’s really great to see a change go in like this one that directly addresses some specific developer frustration/confusion |
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.
Description
Add usage notes to OffscreenCanvas.transferToImageBitmap regarding the ImageBitmap's lifetime.
Reference these notes from the top-level OffscreenCanvas documentation.
Motivation
Some web developers have noted that transferToImageBitmap can be confusing and lead to application bugs; crbug.com/1457212 is one recent example. Add more details to the API doc describing the necessity to either
consume or close the ImageBitmap this API creates, and mention an alternative.
Additional details
crbug.com/1457212 contains a minimized test case from a Chromium customer which was incorrect and which
led to application instability. The customer noted that they used MDN's OffscreenCanvas documentation as a
primary source of information, and requested that the documentation be expanded with this information.
Related issues and pull requests
None