Add missing deprecations to CupertinoDynamicColor. #171160

ksokolovskyi · 2025-06-25T14:20:52Z

Closes #171059

Description

Adds missing deprecations to CupertinoDynamicColor
Adds dart fixes for some of the deprecations

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

dkwingsmt · 2025-06-25T18:23:42Z

@matanlurey Would you like to review this PR, since you worked on it before? If not I can handle it.

ksokolovskyi · 2025-06-30T09:03:10Z

@matanlurey, could you please take a look at this PR when you have time?
Thanks in advance!

dkwingsmt

Generally looking good to me except for one.

dkwingsmt · 2025-07-21T22:09:19Z

packages/flutter/lib/src/cupertino/colors.dart

  int get alpha => _effectiveColor.alpha;

+  @Deprecated(
+    'Use (*.b * 255.0).round() & 0xff. '


Is & 0xff correct? While this operation seems to deal with the cases where (*.b * 255.0).round() is out of [0, 255], it won't because 0xff will convert 256 to 0. I think it should be

Suggested change

'Use (*.b * 255.0).round() & 0xff. '

'Use (*.b * 255.0).round().clamp(0, 255). '

Hi @dkwingsmt, thanks a lot for your review.

I agree that clamping is better than & 0xff. I copied this comment from the Color class:

flutter/engine/src/flutter/lib/ui/painting.dart

Lines 284 to 286 in 8d126a9

/// The blue channel of this color in an 8 bit value.

@Deprecated('Use (*.b * 255.0).round() & 0xff')

int get blue => (0x000000ff & value) >> 0;

Maybe then it makes sense to update the comments in Color class as well as _floatToInt8 method and _fromARGBC constructor? What do you think?

flutter/engine/src/flutter/lib/ui/painting.dart

Lines 217 to 219 in 8d126a9

static int _floatToInt8(double x) {

return (x * 255.0).round() & 0xff;

}

flutter/engine/src/flutter/lib/ui/painting.dart

Lines 176 to 177 in 8d126a9

const Color._fromARGBC(int alpha, int red, int green, int blue, ColorSpace colorSpace)

: this._fromRGBOC(red, green, blue, (alpha & 0xff) / 255, colorSpace);

Hi @gaaclarke, as far as I know, you worked on wide gamut support, so could you please help us here?

Yea that sounds like a fine change if you want to make it. It only matters if you have values outside of [0,1]. We don't force that because for the extended srgb colorspace, that's valid. So, using extended srgb with legacy component accessors could result in unexpected results.

On the other hand, clamping is more expensive than the bitwise-and. This isn't really a big deal because the deprecation of the old accessors happened at the same time as the introduction of extended srgb, so it wasn't breaking anyone.

Maybe then it makes sense to update the comments in Color class as well as _floatToInt8 method and _fromARGBC constructor? What do you think?

I think that's a good change :)

For the record: The following table compares the conversion results of the 3 approaches, which are & 0xff, .clamp, and nothing at all.

(No postprocess) & 0xff .clamp(0, 255)

-0.004 -1 255 0

0.000 0 0 0

0.004 1 1 1

...

0.996 254 254 254

1.000 255 255 255

1.004 256 0 255

Although & 0xff also manages to limit the result within [0, 255], it does so in an discontinuous way and is probably never what users want either.

ksokolovskyi · 2025-07-22T09:46:49Z

I am not sure about whether the deprecation notice has to be added on the website, as CupertinoDynamicColor is a Color and such a notice for Color already exists here: https://docs.flutter.dev/release/breaking-changes/wide-gamut-framework

dkwingsmt · 2025-07-22T21:33:57Z

I am not sure about whether the deprecation notice has to be added on the website, as CupertinoDynamicColor is a Color and such a notice for Color already exists here: https://docs.flutter.dev/release/breaking-changes/wide-gamut-framework

Yeah I think it's worth a short notice, which can largely refers to https://docs.flutter.dev/release/breaking-changes/wide-gamut-framework. Thank you for noticing it!

ksokolovskyi · 2025-07-23T12:42:20Z

@dkwingsmt @gaaclarke Thanks for your reviews!

I've replaced & 0xff with .clamp(0, 255) where it was possible. Unfortunately, it is not possible to use the clamp method in Color._fromARGBC and Color._fromRGBOC as those constructors are const, so I left & 0xff there in place.

As well, I've filed a website PR which adds a breaking change doc explaining introduced deprecations: flutter/website#12236

#12236) Adds breaking changes doc for deprecations introduced in `CupertinoDynamicColor` after wide gamut changes. Depends on flutter/flutter#171160 ## Presubmit checklist - [X] If you are unwilling, or unable, to sign the CLA, even for a _tiny_, one-word PR, please file an issue instead of a PR. - [X] If this PR is not meant to land until a future stable release, mark it as draft with an explanation. - [X] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style)—for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first-person pronouns). - [X] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>

packages/flutter/lib/fix_data/fix_cupertino.yaml

Piinks · 2025-07-23T23:30:10Z

Apologies for the mix up while I remembered why those others we omitted. I was able to fix the newline, so I think we can go ahead an land this!

Piinks

LGTM

dkwingsmt

LGTM

…/flutter#171160)

flutter/flutter@afba7d7...20788c0 2025-07-24 [email protected] Roll Packages from 9c85e5e to 963550c (4 revisions) (flutter/flutter#172696) 2025-07-24 [email protected] Add missing deprecations to CupertinoDynamicColor. (flutter/flutter#171160) 2025-07-24 [email protected] Roll Dart SDK from a181fe571dc8 to 26dece893751 (2 revisions) (flutter/flutter#172683) 2025-07-24 [email protected] Migrate to null aware elements - Part 1 (flutter/flutter#172198) 2025-07-24 [email protected] licenses_cpp: implements extracting regions from matched text (flutter/flutter#172655) 2025-07-24 [email protected] Roll pub packages (flutter/flutter#172677) 2025-07-24 [email protected] Marks Mac_ios keyboard_hot_restart_ios to be unflaky (flutter/flutter#168053) 2025-07-24 [email protected] Roll Abseil and remove a workaround for a Fuchsia target that was unable to build Abseil (flutter/flutter#172665) 2025-07-24 [email protected] Add `automaticallyImplyActions` property to AppBar (flutter/flutter#171113) 2025-07-24 [email protected] fix: TabBar fontFamily inheritance with custom label styles (flutter/flutter#171699) 2025-07-23 [email protected] Marks Linux_mokey new_gallery__crane_perf to be unflaky (flutter/flutter#167633) 2025-07-23 [email protected] [android] Fix broken `--android-skip-build-dependency-validation` flag (flutter/flutter#172581) 2025-07-23 [email protected] Fix: Ensure Text widget locale is included in semantics language tag (flutter/flutter#172034) 2025-07-23 [email protected] [Web][a11y] Update selected chips semantics (flutter/flutter#172660) 2025-07-23 [email protected] Roll Skia from eea1c33fbe84 to 094ac350125f (29 revisions) (flutter/flutter#172664) 2025-07-23 [email protected] Marks Mac_arm64_ios imitation_game_flutter to be unflaky (flutter/flutter#168052) 2025-07-23 [email protected] Roll Dart SDK from a31774a3d049 to a181fe571dc8 (2 revisions) (flutter/flutter#172667) 2025-07-23 [email protected] Adapt xcresult parser for Xcode 16 changes (flutter/flutter#172596) 2025-07-23 [email protected] Update excluded_files to match the current output of the old license checker (flutter/flutter#172670) 2025-07-23 [email protected] Manual Roll of Dart SDK from da9e0299c120 to a31774a3d049 (flutter/flutter#172616) 2025-07-23 [email protected] [FGP] Small restructuring of Android Studio native flutter dependency support (flutter/flutter#172651) 2025-07-23 [email protected] revert: Replaces legacy licenses check with licenses_cpp (flutter/flutter#172568) 2025-07-23 [email protected] fix: size-exp naming (flutter/flutter#172647) 2025-07-23 [email protected] Roll Fuchsia Test Scripts from MnFlN7VWM_7h7EmBV... to BWj3yYC74ud58QhN0... (flutter/flutter#172646) 2025-07-23 [email protected] [DisplayList] implement shadow bounds without relying on Skia utilities (flutter/flutter#172572) 2025-07-23 [email protected] Update `dev/bots/post_process_docs.dart` to use `flutter.version.json` (flutter/flutter#172601) 2025-07-23 [email protected] Emit a warning on `--[no-]disable-dds`, preferring `--no-dds` (flutter/flutter#172595) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…r#9670) flutter/flutter@afba7d7...20788c0 2025-07-24 [email protected] Roll Packages from 9c85e5e to 963550c (4 revisions) (flutter/flutter#172696) 2025-07-24 [email protected] Add missing deprecations to CupertinoDynamicColor. (flutter/flutter#171160) 2025-07-24 [email protected] Roll Dart SDK from a181fe571dc8 to 26dece893751 (2 revisions) (flutter/flutter#172683) 2025-07-24 [email protected] Migrate to null aware elements - Part 1 (flutter/flutter#172198) 2025-07-24 [email protected] licenses_cpp: implements extracting regions from matched text (flutter/flutter#172655) 2025-07-24 [email protected] Roll pub packages (flutter/flutter#172677) 2025-07-24 [email protected] Marks Mac_ios keyboard_hot_restart_ios to be unflaky (flutter/flutter#168053) 2025-07-24 [email protected] Roll Abseil and remove a workaround for a Fuchsia target that was unable to build Abseil (flutter/flutter#172665) 2025-07-24 [email protected] Add `automaticallyImplyActions` property to AppBar (flutter/flutter#171113) 2025-07-24 [email protected] fix: TabBar fontFamily inheritance with custom label styles (flutter/flutter#171699) 2025-07-23 [email protected] Marks Linux_mokey new_gallery__crane_perf to be unflaky (flutter/flutter#167633) 2025-07-23 [email protected] [android] Fix broken `--android-skip-build-dependency-validation` flag (flutter/flutter#172581) 2025-07-23 [email protected] Fix: Ensure Text widget locale is included in semantics language tag (flutter/flutter#172034) 2025-07-23 [email protected] [Web][a11y] Update selected chips semantics (flutter/flutter#172660) 2025-07-23 [email protected] Roll Skia from eea1c33fbe84 to 094ac350125f (29 revisions) (flutter/flutter#172664) 2025-07-23 [email protected] Marks Mac_arm64_ios imitation_game_flutter to be unflaky (flutter/flutter#168052) 2025-07-23 [email protected] Roll Dart SDK from a31774a3d049 to a181fe571dc8 (2 revisions) (flutter/flutter#172667) 2025-07-23 [email protected] Adapt xcresult parser for Xcode 16 changes (flutter/flutter#172596) 2025-07-23 [email protected] Update excluded_files to match the current output of the old license checker (flutter/flutter#172670) 2025-07-23 [email protected] Manual Roll of Dart SDK from da9e0299c120 to a31774a3d049 (flutter/flutter#172616) 2025-07-23 [email protected] [FGP] Small restructuring of Android Studio native flutter dependency support (flutter/flutter#172651) 2025-07-23 [email protected] revert: Replaces legacy licenses check with licenses_cpp (flutter/flutter#172568) 2025-07-23 [email protected] fix: size-exp naming (flutter/flutter#172647) 2025-07-23 [email protected] Roll Fuchsia Test Scripts from MnFlN7VWM_7h7EmBV... to BWj3yYC74ud58QhN0... (flutter/flutter#172646) 2025-07-23 [email protected] [DisplayList] implement shadow bounds without relying on Skia utilities (flutter/flutter#172572) 2025-07-23 [email protected] Update `dev/bots/post_process_docs.dart` to use `flutter.version.json` (flutter/flutter#172601) 2025-07-23 [email protected] Emit a warning on `--[no-]disable-dds`, preferring `--no-dds` (flutter/flutter#172595) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…/flutter#171160)

Add missing deprecations to CupertinoDynamicColor.

1bb6837

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: cupertino flutter/packages/flutter/cupertino repository c: tech-debt Technical debt, code quality, testing, etc. labels Jun 25, 2025

ksokolovskyi added 3 commits June 25, 2025 16:23

Add links to the PR.

afda3e0

Merge branch 'master' into add-deprecations-to-cupertino-dynamic-color

f7356af

Add version to deprecation notices.

140fd71

dkwingsmt self-requested a review July 2, 2025 18:12

ksokolovskyi added 2 commits July 8, 2025 09:23

Merge branch 'master' into add-deprecations-to-cupertino-dynamic-color

403226d

Merge branch 'master' into add-deprecations-to-cupertino-dynamic-color

8d126a9

dkwingsmt requested a review from Piinks July 16, 2025 18:21

dkwingsmt reviewed Jul 21, 2025

View reviewed changes

Merge branch 'master' into add-deprecations-to-cupertino-dynamic-color

b01909b

ksokolovskyi added 2 commits July 23, 2025 09:46

Merge branch 'master' into add-deprecations-to-cupertino-dynamic-color

f59c300

Replace bitwise AND with clamp.

9365468

github-actions bot added the engine flutter/engine related. See also e: labels. label Jul 23, 2025

Revert some clamp usages.

ba1493f

ksokolovskyi mentioned this pull request Jul 23, 2025

Add breaking changes doc for CupertinoDynamicColor wide gamut changes. flutter/website#12236

Merged

4 tasks

dkwingsmt self-requested a review July 23, 2025 18:25

Piinks reviewed Jul 23, 2025

View reviewed changes

packages/flutter/lib/fix_data/fix_cupertino.yaml Outdated Show resolved Hide resolved

Piinks reviewed Jul 23, 2025

View reviewed changes

packages/flutter/lib/fix_data/fix_cupertino.yaml Outdated Show resolved Hide resolved

Update packages/flutter/lib/fix_data/fix_cupertino.yaml

9a358fa

Piinks approved these changes Jul 23, 2025

View reviewed changes

Merge branch 'master' into add-deprecations-to-cupertino-dynamic-color

25fef8f

dkwingsmt approved these changes Jul 24, 2025

View reviewed changes

ksokolovskyi added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 24, 2025

auto-submit bot added this pull request to the merge queue Jul 24, 2025

Merged via the queue into flutter:master with commit 79d77a1 Jul 24, 2025
175 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 24, 2025

engine-flutter-autoroll mentioned this pull request Jul 24, 2025

Roll Flutter from afba7d75b391 to 79d77a138732 (26 revisions) flutter/packages#9669

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 24, 2025

79d77a138 Add missing deprecations to CupertinoDynamicColor. (flutter…

a967015

…/flutter#171160)

engine-flutter-autoroll mentioned this pull request Jul 24, 2025

Roll Flutter from afba7d75b391 to 20788c07fcb8 (27 revisions) flutter/packages#9670

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 24, 2025

79d77a138 Add missing deprecations to CupertinoDynamicColor. (flutter…

5a5fe08

…/flutter#171160)

Piinks mentioned this pull request Jul 25, 2025

Flutter Notable Commits - 2025 #161460

Open

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 12, 2025

79d77a138 Add missing deprecations to CupertinoDynamicColor. (flutter…

607c38e

…/flutter#171160)

	'Use (.b 255.0).round() & 0xff. '
	'Use (.b 255.0).round().clamp(0, 255). '

	/// The blue channel of this color in an 8 bit value.
	@Deprecated('Use (.b 255.0).round() & 0xff')
	int get blue => (0x000000ff & value) >> 0;

	static int _floatToInt8(double x) {
	return (x * 255.0).round() & 0xff;
	}

	const Color._fromARGBC(int alpha, int red, int green, int blue, ColorSpace colorSpace)
	: this._fromRGBOC(red, green, blue, (alpha & 0xff) / 255, colorSpace);

	(No postprocess)	`& 0xff`	`.clamp(0, 255)`
-0.004	-1	255	0
0.000	0	0	0
0.004	1	1	1
...
0.996	254	254	254
1.000	255	255	255
1.004	256	0	255

Add missing deprecations to CupertinoDynamicColor. #171160

Add missing deprecations to CupertinoDynamicColor. #171160

Uh oh!

Conversation

ksokolovskyi commented Jun 25, 2025

Description

Pre-launch Checklist

Uh oh!

dkwingsmt commented Jun 25, 2025

Uh oh!

ksokolovskyi commented Jun 30, 2025

Uh oh!

dkwingsmt left a comment

Choose a reason for hiding this comment

Uh oh!

dkwingsmt Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

ksokolovskyi Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

ksokolovskyi Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

gaaclarke Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

dkwingsmt Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

ksokolovskyi commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dkwingsmt commented Jul 22, 2025

Uh oh!

ksokolovskyi commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

Piinks commented Jul 23, 2025

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

dkwingsmt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ksokolovskyi commented Jul 22, 2025 •

edited

Loading