Repository navigation
Commit 8c1cad1
authored
[web] Support FragmentShader.getImageSampler on CanvasKit and Skwasm (flutter#195854)
<!--
Thanks for filing a pull request!
Reviewers are typically assigned within a week of filing a request.
To learn more about code review, see our documentation on Tree Hygiene:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
-->
Implements `FragmentShader.getImageSampler(name)` on the CanvasKit and
Skwasm web renderers. Before this change, both backends threw
`UnsupportedError`, so web apps could bind float and matrix uniforms by
name but not image samplers.
The sampler index lookup now lives in `ShaderData.getImageSamplerIndex`,
which both backends share. It is a port of the native
`_getImageSamplerIndex`: the index counts only sampler uniforms, and the
error messages are the same as native. `BackendFragmentShader` now
exposes a plain `int getImageSamplerIndex(String name)` query instead of
returning a slot. `EngineFragmentShader` builds an
`EngineImageSamplerSlot` whose `set` calls
`EngineFragmentShader.setImageSampler`, so binding through a slot gets
the same sampler disposal, finalizer handling, and picture image
retention as calling `setImageSampler` directly.
Fixes flutter#194290
## Behavioral Changes
- `FragmentShader.getImageSampler(name)` on CanvasKit and Skwasm:
- Before: always threw `UnsupportedError('getImageSampler is not
supported on the web.')`.
- After: returns an `ImageSamplerSlot`. Its `name` is the queried name,
and its `shaderIndex` is the 0-based position of that sampler among the
shader's sampler uniforms (float uniforms are not counted).
`slot.set(image)` does the same thing as
`shader.setImageSampler(slot.shaderIndex, image)`.
- Invalid names now throw `ArgumentError` with the native messages:
- a non-sampler uniform: `Uniform "<name>" is not an image sampler.`
- an unknown name: `No uniform named "<name>".`
- Calling `slot.set` after the shader is disposed fails the same debug
assertion as `setImageSampler`.
- Web Impeller (wimp) does not implement runtime effects yet (flutter#175431),
so nothing changes there.
## Where to focus
- **Where the slot is built:** the backend only answers a name-to-index
query, and the frontend `EngineFragmentShader` builds the slot. That
keeps image lifetime bookkeeping (`samplerImages`, which the picture
image tracker reads, disposal of the replaced sampler, and finalizers)
in one place. A slot built by the backend that called the backend's
`setImageSampler` directly would skip that bookkeeping. This is also why
the sampler slot is built in a different layer from the float uniform
slots.
- **Index semantics:** `ShaderData.getImageSamplerIndex` counts only
`SampledImage` uniforms that come before the match. That matches the
index space that `CkFragmentShader.setImageSampler` (`samplers[index]`)
and `SkwasmFragmentShader.setImageSampler` (child shader `index`)
already use.
- **`CkFragmentProgram`** now keeps its `ShaderData`, as
`SkwasmFragmentProgram` already did, and exposes `uniforms`,
`floatCount` and `textureCount` as getters.
- **Tests:** a new `two_samplers` SkSL fixture puts samplers between
float uniforms. It covers index ordering and binding in reverse
declaration order through real pixels.
- **Files to review first:**
1. `lib/src/engine/primitives/shader.dart`
2. `lib/src/engine/shader_data.dart`
3. `test/ui/fragment_shader_test.dart` (the `getImageSampler` group)
## 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 451069b commit 8c1cad1
7 files changed
Lines changed: 470 additions & 27 deletions
File tree
- engine/src/flutter/lib/web_ui
- lib/src/engine
- backend
- canvaskit
- primitives
- skwasm/skwasm_impl
- test/ui
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
23 | 25 | | |
24 | 26 | | |
25 | 27 | | |
| |||
34 | 36 | | |
35 | 37 | | |
36 | 38 | | |
37 | | - | |
38 | 39 | | |
39 | 40 | | |
40 | 41 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
| 22 | + | |
29 | 23 | | |
30 | 24 | | |
31 | 25 | | |
32 | 26 | | |
33 | | - | |
34 | | - | |
35 | | - | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
36 | 31 | | |
37 | 32 | | |
38 | 33 | | |
39 | | - | |
| 34 | + | |
40 | 35 | | |
41 | 36 | | |
42 | 37 | | |
| |||
317 | 312 | | |
318 | 313 | | |
319 | 314 | | |
320 | | - | |
321 | | - | |
322 | | - | |
323 | | - | |
324 | | - | |
325 | 315 | | |
326 | 316 | | |
327 | 317 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
174 | 174 | | |
175 | 175 | | |
176 | 176 | | |
| 177 | + | |
177 | 178 | | |
178 | 179 | | |
179 | 180 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
326 | 326 | | |
327 | 327 | | |
328 | 328 | | |
329 | | - | |
| 329 | + | |
330 | 330 | | |
331 | 331 | | |
332 | 332 | | |
333 | 333 | | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
334 | 340 | | |
335 | 341 | | |
336 | 342 | | |
| |||
408 | 414 | | |
409 | 415 | | |
410 | 416 | | |
411 | | - | |
| 417 | + | |
| 418 | + | |
412 | 419 | | |
413 | 420 | | |
414 | 421 | | |
| |||
431 | 438 | | |
432 | 439 | | |
433 | 440 | | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
98 | 120 | | |
99 | 121 | | |
100 | 122 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
195 | 195 | | |
196 | 196 | | |
197 | 197 | | |
| 198 | + | |
198 | 199 | | |
199 | 200 | | |
200 | 201 | | |
| |||
226 | 227 | | |
227 | 228 | | |
228 | 229 | | |
229 | | - | |
| 230 | + | |
| 231 | + | |
230 | 232 | | |
231 | 233 | | |
232 | 234 | | |
| |||
474 | 476 | | |
475 | 477 | | |
476 | 478 | | |
477 | | - | |
478 | | - | |
479 | | - | |
480 | | - | |
481 | | - | |
482 | 479 | | |
483 | 480 | | |
484 | 481 | | |
| |||
0 commit comments