Change createImageBitMaps's imageOrientation "none" to "from-image"

[zcorpan]

If it's web compatible, consider renaming the imageOrientation value "none" to "from-image" to match CSS's image-orientation property (and make it the default value), and add a new "none" that has the same semantics as CSS's none.

[...] CreateImageBitmap has an imageOrientation option. Unfortunately that spec and the CSS images level 3 spec were written without knowledge of each other, so we are in this awkward situation where passing {imageOrientation: "none"} to createImageBitmap is equivalent to {image-orientation: from-image} in CSS. createImageBitmap does not currently have an option that is equivalent to CSS's {image-orientation: none}, but it would be pretty easy to add that.

Before moving forward, I would like to add instrumentation to chromium to measure whether anyone is using {ImageOrientation: "none"} explicitly with createImageBitmap. If not, we could change the createImageBitmap spec to match the CSS semantics and change the default to "from-image", which would avoid breaking backwards compat for call sites that use the default. [...]

Originally posted by @junov in https://github.com/whatwg/html/issues/4495#issuecomment-1176695685

cc @whatwg/canvas

[zcorpan]

I ran this query in HTTP Archive. 0 results.

SELECT
  *
FROM (
  SELECT
    page,
    url,
    REGEXP_EXTRACT(body, r'(createImageBitmap\([^,\)]+,\s*{\s*imageOrientation\s*:\s*["\']none["\'])') AS match
  FROM
     `httparchive.response_bodies.2022_06_09_mobile`)
WHERE
  match IS NOT NULL

(I noticed a slight bug in the query: imageOrientation might not be the first member of options.)

There are matches in GitHub search, though.

[junov]

It looks like the only production code in the GitHub search to use imageOrientation:"none" is three.js and it's many clones. The rest of the hits are clones of web platform tests. This should be quite manageable. We can start by adding "from-image", making it synonymous with "none". And then deprecate "none". Once we are satisfied that usage of "none" is extinct, we can flip its meaning to match CSS. Does that sound reasonable?

On Thu, Jul 7, 2022, 4:45 a.m. Simon Pieters @.***> wrote:

I ran this query in HTTP Archive. 0 results.

SELECT * FROM ( SELECT page, url, REGEXP_EXTRACT(body, r'(createImageBitmap([^,)]+,\s*{\simageOrientation\s:\s*["']none["'])') AS match FROM httparchive.response_bodies.2022_06_09_mobile) WHERE match IS NOT NULL

(I noticed a slight bug in the query: imageOrientation might not be the first member of options.)

There are matches in GitHub search https://github.com/search?q=createimagebitmap+imageorientation&type=code, though.

— Reply to this email directly, view it on GitHub https://github.com/whatwg/html/issues/8085#issuecomment-1177263795, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAT4V6GPAMMWLIURGENKTNTVS2KI3ANCNFSM524RDIWQ . You are receiving this because you were mentioned.Message ID: @.***>

[zcorpan]

If the breakage seems manageable right now, I think a more aggressive approach could actually be less risk because there's less time between now and the desired end state in which new content can appear that depends on the current semantics of "none", which might not be manageable anymore (or at least, it could trend up instead of trending down). That is:

1. ASAP implement and ship the renaming of "none" to "from-image". Maybe make usage of "none" throw an exception, which can inform developers about the change. Reach out to the known users and ask them to switch to "from-image".
2. At least one release milestone later, implement and ship the new "none" value.

However, I think your suggested approach also sounds reasonable, but I would suggest outreach and at least a console message when using "none" in the transition period, and try to keep the transition period short.

[junov]

Okay, in terms of PRs against the spec should we start by renaming "none" to "from-image", and in a later PR, re-add "none" with the new semantics?

[zcorpan]

Sounds good to me.

[kenrussell]

From a web compatibility standpoint I think that throwing an exception upon use of imageOrientation: none is too aggressive - it would cause web pages to completely stop working, rather than potentially (not definitely) displaying incorrect results. A deprecation warning to the console would be more developer- and user-friendly.

Agree with trying to minimize the deprecation and switch-over period.

CC @mrdoob since the main use of this dictionary element is Three.js.

[mrdoob]

What would be the right way for adopting this without having to do user agent checks? We tend to just wait until the feature has been implemented in all major browsers.

[junov]

@mrdoob: Today, you could just remove imageOrientation: "none" everywhere. It won't change the code's behavior because that's the default anyways. Only keep "imageOrientation" in places where you set it to "flipY".

[junov]

I am currently writing a spec change for this, and I realized there are issues with how flipY is defined as well. I created a new issue for this: #8118

[zcorpan]

@junov I see a commit but no PR. Did you mean to open a PR?

[mrdoob]

@mrdoob: Today, you could just remove imageOrientation: "none" everywhere. It won't change the code's behavior because that's the default anyways. Only keep "imageOrientation" in places where you set it to "flipY".

Done!

[smaug----]

@kdashg do you happen to have an opinion to this?

[kdashg]

Sounds like a good idea, and sounds like the webcompat story checks out, thanks all!

[annevk]

@junov it seems there's no PR here still.

[yiyix]

@annevk, PR is created: https://github.com/whatwg/html/pull/8710

[zcorpan]

PR was merged, closing.

[zcorpan]

Okay, in terms of PRs against the spec should we start by renaming "none" to "from-image", and in a later PR, re-add "none" with the new semantics?

I realized now that the second part hasn't happened yet. Reopening to add none with the new semantics. Also see https://github.com/whatwg/html/pull/8710#issuecomment-1379790963