fix: normalize color space for consistent pixel values in nativeImage by felixrieseberg · Pull Request #48178 · electron/electron

felixrieseberg · 2025-08-27T05:08:00Z

Description of Change

This PR normalizes color space so that pixel values in nativeImage match if they do match visually to the user. I am not entirely sure whether we actually want this - a priori, I think this feels correct but I'm happy to be corrected.

Closes #46949

Checklist

PR description included and stakeholders cc'd
npm test passes
tests are changed or added
relevant API documentation, tutorials, and examples are updated and follow the documentation style guide
PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: fix: If a nativeImage was passed an image with a color profile, its pixel values will now be normalized to SRGB. This ensures that two visually identical images after color space application will receive similar pixel values when converted to a nativeImage.

nikwen · 2025-08-27T12:35:01Z

We might want to consider this a breaking change, just to make sure we don't break any apps relying on the old behavior.

felixrieseberg · 2025-08-28T19:32:34Z

I'll let @reitowo decide! I think breaking change seems reasonable

codebytere

Conceptually LGTM - i'm leaving semver-major for this as well.

felixrieseberg · 2026-01-24T19:05:08Z

It only took me forever but I have integrated all feedback and rebased!

reitowo

API LGTM with a minor nit suggestion

samuelmaddock

API LGTM

Open to include nativeImage.getColorSpace in this PR or separate as per @reitowo's feedback.

Will approve once tests are passing.

reitowo · 2026-02-25T03:35:28Z

I think this is ready for merge?

jkleinsc

We should update the breaking changes to either 42 or 43 depending upon whether or not we want this to land in 42 or 43. I'm fine with it going into 42.

toBitmap() now normalizes the color space to sRGB by default, ensuring that visually identical images produce consistent pixel values regardless of their original color profile (e.g., Display P3 on macOS). An optional colorSpace parameter is added to toBitmap() to control the target color space: 'srgb' (default), 'display-p3', or 'source' (no conversion). Closes electron#46949

Sort ui/gfx/ includes alphabetically: codec/jpeg_codec.h, codec/png_codec.h, then color_space.h.

- Add breaking-changes.md entry for toBitmap() color space normalization under Planned Breaking API Changes (41.0) - Update getBitmap() docs to include colorSpace option and breaking-changes-header since it delegates to toBitmap()

Regenerate the colorspace-srgb.png and colorspace-p3.png test fixtures so they represent the same visual color encoded in two different source color spaces. The updated sRGB fixture stores the color as sRGB pixel values, while the Display P3 fixture stores the corresponding Display P3 pixel values and retains its embedded P3 ICC profile. Even though the source bitmaps can contain different bytes, their outputs should be byte-identical after normalization to the sRGB color space.

ckerr · 2026-04-28T16:43:34Z

We should update the breaking changes to either 42 or 43 depending upon whether or not we want this to land in 42 or 43. I'm fine with it going into 42.

I think I'd be OK with 42 if anyone feels strongly about it, but -- since it's a month later now -- it feels a little late in the cycle?

I've pushed two changes up to unblock this PR:

updated breaking-changes.md to put this change in 43.0 to address @jkleinsc's change request
rebased to main

release-clerk · 2026-05-08T18:57:35Z

Release Notes Persisted

fix: If a nativeImage was passed an image with a color profile, its pixel values will now be normalized to SRGB. This ensures that two visually identical images after color space application will receive similar pixel values when converted to a nativeImage.

trop · 2026-05-08T18:57:49Z

I have automatically backported this PR to "43-x-y", please check out #51565

…#51565) fix: normalize color space for consistent pixel values in nativeImage (#48178) * fix: normalize color space for consistent pixel values in nativeImage toBitmap() now normalizes the color space to sRGB by default, ensuring that visually identical images produce consistent pixel values regardless of their original color profile (e.g., Display P3 on macOS). An optional colorSpace parameter is added to toBitmap() to control the target color space: 'srgb' (default), 'display-p3', or 'source' (no conversion). Closes #46949 * fix: implement feedback * fix: correct include ordering in electron_api_native_image.cc Sort ui/gfx/ includes alphabetically: codec/jpeg_codec.h, codec/png_codec.h, then color_space.h. * docs: add breaking-changes entry and update getBitmap docs - Add breaking-changes.md entry for toBitmap() color space normalization under Planned Breaking API Changes (41.0) - Update getBitmap() docs to include colorSpace option and breaking-changes-header since it delegates to toBitmap() * docs: linter: remove semicolons from js code samples * docs: linter: make change description <= 120 chars * test: fix new colorSpace spec * test: regenerate nativeImage color-space PNG fixtures Regenerate the colorspace-srgb.png and colorspace-p3.png test fixtures so they represent the same visual color encoded in two different source color spaces. The updated sRGB fixture stores the color as sRGB pixel values, while the Display P3 fixture stores the corresponding Display P3 pixel values and retains its embedded P3 ICC profile. Even though the source bitmaps can contain different bytes, their outputs should be byte-identical after normalization to the sRGB color space. * docs: marked breaking change for 43.0 * chore: fix up for lint --------- Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Felix Rieseberg <f@anthropic.com>

electron-cation Bot added the new-pr 🌱 PR opened recently label Aug 27, 2025

felixrieseberg force-pushed the felixr/native-image-color-normalization branch from 1445729 to 75f0685 Compare August 28, 2025 19:30

codebytere reviewed Aug 29, 2025

View reviewed changes

Comment thread spec/api-native-image-spec.ts Resolved

Comment thread spec/api-native-image-spec.ts Resolved

reitowo reviewed Aug 29, 2025

View reviewed changes

Comment thread shell/common/api/electron_api_native_image.cc Resolved

electron-cation Bot removed the new-pr 🌱 PR opened recently label Sep 3, 2025

codebytere added semver/major incompatible API changes api-review/requested 🗳 labels Oct 8, 2025

samuelmaddock added the wip ⚒ label Jan 22, 2026

felixrieseberg force-pushed the felixr/native-image-color-normalization branch from 75f0685 to cb2e462 Compare January 24, 2026 19:02

felixrieseberg removed the wip ⚒ label Jan 24, 2026

felixrieseberg requested review from codebytere and samuelmaddock January 24, 2026 19:04

reitowo approved these changes Jan 25, 2026

View reviewed changes

Comment thread spec/api-native-image-spec.ts Resolved

samuelmaddock reviewed Jan 29, 2026

View reviewed changes

Comment thread docs/api/native-image.md Resolved

reitowo reviewed Jan 29, 2026

View reviewed changes

Comment thread docs/api/native-image.md Resolved

reitowo reviewed Feb 3, 2026

View reviewed changes

Comment thread docs/api/native-image.md Resolved

samuelmaddock reviewed Feb 5, 2026

View reviewed changes

electron-cation Bot added api-review/approved ✅ and removed api-review/requested 🗳 labels Feb 5, 2026

itsananderson reviewed Feb 5, 2026

View reviewed changes

Comment thread docs/api/native-image.md Resolved

Comment thread docs/api/native-image.md Resolved

felixrieseberg requested a review from a team as a code owner February 9, 2026 03:29

ckerr added the no-backport label Mar 4, 2026

ckerr force-pushed the felixr/native-image-color-normalization branch 3 times, most recently from 983322a to 69a031e Compare March 23, 2026 17:31

ckerr approved these changes Mar 23, 2026

View reviewed changes

jkleinsc requested changes Mar 26, 2026

View reviewed changes

felixrieseberg and others added 9 commits April 28, 2026 11:33

fix: implement feedback

47df77d

fix: correct include ordering in electron_api_native_image.cc

cf631ab

Sort ui/gfx/ includes alphabetically: codec/jpeg_codec.h, codec/png_codec.h, then color_space.h.

docs: linter: remove semicolons from js code samples

f2d509a

docs: linter: make change description <= 120 chars

0751a8e

test: fix new colorSpace spec

5caf925

docs: marked breaking change for 43.0

a4bb37c

ckerr force-pushed the felixr/native-image-color-normalization branch from da8835a to a4bb37c Compare April 28, 2026 16:41

ckerr requested a review from jkleinsc April 28, 2026 16:43

Merge branch 'main' into felixr/native-image-color-normalization

10894ee

jkleinsc approved these changes May 7, 2026

View reviewed changes

jkleinsc added target/43-x-y PR should also be added to the "43-x-y" branch. and removed no-backport labels May 7, 2026

jkleinsc added 2 commits May 8, 2026 11:13

Merge branch 'main' into felixr/native-image-color-normalization

8b2ddaa

chore: fix up for lint

4388b61

jkleinsc merged commit 0e354e8 into electron:main May 8, 2026
69 checks passed

trop Bot mentioned this pull request May 8, 2026

fix: normalize color space for consistent pixel values in nativeImage #51565

Merged

trop Bot added in-flight/43-x-y and removed target/43-x-y PR should also be added to the "43-x-y" branch. labels May 8, 2026

trop Bot added merged/43-x-y PR was merged to the "43-x-y" branch. and removed in-flight/43-x-y labels May 8, 2026

dsanders11 added the 44-x-y label Jul 10, 2026

dsanders11 added this to 44-x-y Jul 10, 2026

Conversation

felixrieseberg commented Aug 27, 2025 • edited by codebytere Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Checklist

Release Notes

Uh oh!

nikwen commented Aug 27, 2025

Uh oh!

felixrieseberg commented Aug 28, 2025

Uh oh!

codebytere left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

felixrieseberg commented Jan 24, 2026

Uh oh!

reitowo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samuelmaddock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

reitowo commented Feb 25, 2026

Uh oh!

jkleinsc left a comment

Choose a reason for hiding this comment

Uh oh!

ckerr commented Apr 28, 2026

Uh oh!

Uh oh!

release-clerk Bot commented May 8, 2026

Uh oh!

trop Bot commented May 8, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

felixrieseberg commented Aug 27, 2025 •

edited by codebytere

Loading