Repository navigation
Commit dd5f870
authored
[web] Keep ImageFilter.blur bounds in equality and description (flutter#196013)
On the web, `ImageFilter.blur` accepted the optional `bounds` argument
and then dropped it. As a result, a bounded blur compared equal to the
matching unbounded blur, and its description had no `bounds:` part.
Native keeps `bounds` in `==`, `hashCode` and `debugShortDescription`.
This PR forwards `bounds` from the web `dart:ui` `ImageFilter.blur` to
`EngineBlurImageFilter`, which now stores it and includes it in `==`,
`hashCode` and `debugShortDescription`/`toString()`, in the same format
as native `_GaussianBlurImageFilter` (`blur(10.1, 10.1, clamp, bounds:
Rect.fromLTRB(...))`). Rendering does not change: every web backend
still draws an unbounded blur, which is also what the native Skia
backend does with `bounds`. With framework-visible behavior now matching
native, 'ImageFilter resolves correctly' in
`image_filter_config_test.dart` no longer needs `skip: kIsWeb`.
Part of flutter#175899
## Behavioral Changes
- Web `ImageFilter.blur(..., bounds: r)` equality:
- Before: equal to the same blur without `bounds` (and to one with any
other `bounds`).
- After: equal only to a blur with the same sigmas, tile mode and an
equal `bounds`, and `hashCode` follows the same rule. As on native, a
layer or widget whose filter changes only in `bounds` now counts as
changed.
- Web `ImageFilter.blur(sigmaX: 10.1, sigmaY: 10.1, tileMode:
TileMode.clamp, bounds: Rect.fromLTRB(0.1, 0.1, 100.2, 100.2))`
description:
- Before: `debugShortDescription` was `blur(10.1, 10.1, clamp)`.
- After: it is `blur(10.1, 10.1, clamp, bounds: Rect.fromLTRB(0.1, 0.1,
100.2, 100.2))` (`toString()` gets the `ImageFilter.` prefix), matching
native.
- Blurs without `bounds` behave exactly as before. Rendered output does
not change on any web backend.
## Where to focus
- **Primary review file:**
`engine/src/flutter/lib/web_ui/lib/src/engine/primitives/image_filter.dart`.
`bounds` is an optional, final field on `EngineBlurImageFilter` and
takes part in `==`/`hashCode`/description, mirroring native
`_GaussianBlurImageFilter` field for field (including the
`_boundsString()` helper).
- **Intentional non-change:** `getBackendFilter` and `filterBounds`
ignore `bounds`, so every backend falls back to an unbounded blur, like
the native Skia backend. Passing `bounds` through the renderer, so the
Impeller-based skwasm variant can render a true bounded blur, is a
separate follow-up. Because `bounds` is final, the existing per-instance
backend filter cache (keyed on tile mode) stays valid.
- **Tests:** `test/engine/surface/filters/image_filter_test.dart` uses
one table-driven test for equality, hash, compose and description, and
adds a check that bounded and unbounded blurs report the same
`filterBounds`. It now calls `setUpUnitTests()` because `filterBounds`
needs a renderer. Zero sigmas print as `0` on dart2js and `0.0` on
dart2wasm, so the expected string is built with `0.0.toString()`.
- **Framework test:** the framework's web CI runs against a web SDK
built from the engine in the same commit, so the unskipped test uses the
new `dart:ui` behavior. I checked it locally against a rebuilt web SDK
on Chrome (JS and Wasm), and on the VM.
## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant in-code documentation (doc comments with
`///`).
- [x] If this PR introduces a new feature or capability, I created and
linked a website documentation issue or PR in [flutter/website] (or
verified none is needed).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
If you need help, consider asking for advice on the #hackers-new channel
on [Discord].
If this change needs to override an active code freeze, provide a
comment explaining why. The code freeze workflow can be overridden by
code reviewers. See pinned issues for any active code freezes with
guidance.
**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.
<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/CONTRIBUTING.ai.md
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[flutter/website]: https://github.com/flutter/website
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md1 parent e648016 commit dd5f870
4 files changed
Lines changed: 111 additions & 8 deletions
File tree
- engine/src/flutter/lib/web_ui
- lib
- src/engine/primitives
- test/engine/surface/filters
- packages/flutter/test/rendering
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
645 | 645 | | |
646 | 646 | | |
647 | 647 | | |
648 | | - | |
649 | 648 | | |
650 | | - | |
| 649 | + | |
| 650 | + | |
| 651 | + | |
| 652 | + | |
| 653 | + | |
| 654 | + | |
651 | 655 | | |
652 | 656 | | |
653 | 657 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
22 | 23 | | |
23 | 24 | | |
24 | 25 | | |
| |||
109 | 110 | | |
110 | 111 | | |
111 | 112 | | |
112 | | - | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
113 | 119 | | |
114 | 120 | | |
115 | 121 | | |
116 | 122 | | |
117 | 123 | | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
118 | 131 | | |
119 | 132 | | |
120 | 133 | | |
| |||
153 | 166 | | |
154 | 167 | | |
155 | 168 | | |
| 169 | + | |
156 | 170 | | |
157 | 171 | | |
158 | 172 | | |
159 | 173 | | |
160 | | - | |
| 174 | + | |
161 | 175 | | |
162 | 176 | | |
163 | | - | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
164 | 181 | | |
165 | 182 | | |
166 | 183 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
12 | 14 | | |
13 | 15 | | |
14 | 16 | | |
15 | 17 | | |
16 | 18 | | |
| 19 | + | |
17 | 20 | | |
18 | 21 | | |
19 | 22 | | |
| |||
75 | 78 | | |
76 | 79 | | |
77 | 80 | | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
78 | 162 | | |
79 | 163 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
8 | 7 | | |
9 | 8 | | |
10 | 9 | | |
| |||
129 | 128 | | |
130 | 129 | | |
131 | 130 | | |
132 | | - | |
133 | | - | |
| 131 | + | |
134 | 132 | | |
135 | 133 | | |
0 commit comments