Skip to content

transferToImageBitmap misses information that the "image in the OffscreenCanvas object is replaced with a new blank image." #43687

@jdittrich

Description

@jdittrich

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas/transferToImageBitmap

What specific section or headline is this issue about?

Intro, probably, since it is about a side effect, not a return value

What information was incorrect, unhelpful, or incomplete?

The pages does not inform that: "The image in the OffscreenCanvas object is replaced with a new blank image." (citing the spec).
This might be implied through "The OffscreenCanvas allocates a new image for its subsequent rendering.", but if it is, it is hard to understand (what doe "allocate" imply, what is the "new image"? etc.)

What did you expect to see?

A text like: "The OffscreenCanvas.transferToImageBitmap() method creates an ImageBitmap object from the most recently rendered image of the OffscreenCanvas. The image in the OffscreenCanvas object is replaced with a new blank image." (using the sentence from the spec)

Potential addition: "If you do not want to replace the OffscreenCanvas content but just copy its content to another canvas element, you can use the other canvas’ drawImage method."

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

MDN metadata

Page report details

Metadata

Metadata

Assignees

No one assigned

    Labels

    Content:WebAPIWeb API docsaccepting PRFeel free to open a PR to resolve this issue

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions