Repository navigation
Commit 6b2bb92
authored
[web] Unify ui.Canvas behind a shared EngineCanvas frontend (flutter#196348)
Unifies `ui.Canvas` across CanvasKit and Skwasm behind a shared
`EngineCanvas` frontend (`primitives/canvas.dart`) and stateless
`BackendCanvas` boundary (`backend/canvas.dart`), turning `CkCanvas` and
`SkwasmCanvas` into thin native translators. Centralizing argument
validation, `PictureImageTracker` image retention, the per-draw
`BackendPaint` lifecycle, point/atlas typed-array flattening,
superellipse path emulation, `getLocalClipBounds`, and `WebParagraph`
dispatch brings all web renderers onto a single implementation with
consistent runtime behavior.
Part of flutter#175630
## Behavioral Changes
- **Skwasm and Web Impeller now validate `Canvas` arguments identically
to CanvasKit and native `dart:ui`:**
- Before: Skwasm silently truncated, misread, or passed mismatched
buffer lengths to native code when given a `transform` matrix without 16
entries, an odd-length `drawRawPoints` list, or mismatched
`drawAtlas`/`drawRawAtlas` transform, rect, and color lengths.
- After: Each throws the same `ArgumentError` and message as CanvasKit
and native `dart:ui`, without mutating the save stack, transform, or
tracked images.
- **Consistent debug assertions across all web renderers:**
- Skwasm and Web Impeller now assert on NaN rects, rounded rects,
rounded superellipses, and offsets (including
`clipRSuperellipse`/`drawRSuperellipse` on CanvasKit as well).
- Drawing a disposed `Image`, `Picture`, `Paragraph`, `Vertices`, or
atlas image, or calling `drawAtlas`/`drawRawAtlas` with colors and a
`null` `blendMode`, now throws `AssertionError` across all web renderers
(previously missing, or throwing `StateError` for disposed pictures on
CanvasKit and disposed vertices).
- **`drawAtlas(colors: [])` on Skwasm now treats an empty color list as
"no colors":**
- Before: Skwasm passed a zero-length buffer and native code read one
uninitialized color per sprite.
- After: Matches CanvasKit and native `dart:ui` by passing `null` when
`colors` is empty.
- **`drawParagraph` now supports `WebParagraph` on Skwasm:**
- Before: `SkwasmCanvas.drawParagraph` threw a `TypeError` when given a
`WebParagraph`; only CanvasKit routed it to `WebParagraph.paint`.
- After: `EngineCanvas.drawParagraph` dispatches `WebParagraph` on every
renderer.
## Where to focus
- **`lib/src/engine/primitives/canvas.dart`**: Ordering invariant in
`EngineCanvas`—all validation and throwing delegate unwraps
(`backendPath`, `backendImage`, `EngineVertices.delegate`,
`getBackendFilter`) run before `_tracker` recording and
`createBackendPaint()`, so rejected calls never retain images or leak a
native paint. Image and atlas draws pass `defaultBlurTileMode:
ui.TileMode.clamp`; all other draws use the default decal mode.
- **`lib/src/engine/canvaskit/canvas.dart` and
`lib/src/engine/skwasm/skwasm_impl/canvas.dart`**: Stateless
`BackendCanvas` translators preserving backend-specific conversions
(CanvasKit degree conversion, Mitchell cubic sampling, and float
nine-slice centers; Skwasm `StackScope` conversions, integer nine-slice
centers, and `drawAtlas` `cullRect`).
- **`lib/src/engine/canvaskit/{picture_recorder,picture,surface}.dart`
and `lib/src/engine/skwasm/skwasm_impl/picture.dart`**: Recorders and
internal raster canvases now wrap their backend canvas in
`EngineCanvas`, and `LayerPicture` exposes `imageTracker` so
`EngineCanvas.drawPicture` merges retained image sources in the
frontend.
## 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 627ac6e commit 6b2bb92
22 files changed
Lines changed: 2183 additions & 906 deletions
File tree
- engine/src/flutter/lib/web_ui
- lib/src
- engine
- backend
- canvaskit
- layer
- primitives
- skwasm/skwasm_impl
- raw
- test
- canvaskit
- skwasm
- ui
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
| |||
105 | 106 | | |
106 | 107 | | |
107 | 108 | | |
| 109 | + | |
108 | 110 | | |
109 | 111 | | |
110 | 112 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 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 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
0 commit comments