Skip to content

[web] Support FragmentShader.getImageSampler on CanvasKit and Skwasm - #195854

Merged
auto-submit[bot] merged 7 commits into
flutter:masterfrom
harryterkelsen:flutter-flutter-194290-google3-bug-web
Nov 5, 2026
Merged

auto-submit[bot] merged 7 commits into
flutter:masterfrom
harryterkelsen:flutter-flutter-194290-google3-bug-web

Conversation

@harryterkelsen

Copy link
Copy Markdown
Contributor

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 #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 ([wimp] Implement custom fragment shaders for wimp #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

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. 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.

Pass the program's ShaderData to EngineFragmentShader so that
getImageSampler resolves sampler names in the shared frontend instead of
through identical lookups in the CanvasKit and Skwasm backends, and
describe what the getImageSampler tests cover.
@github-actions github-actions Bot added engine flutter/engine related. See also e: labels. platform-web Web applications specifically team-web Owned by Web platform team labels Nov 3, 2026
@harryterkelsen
harryterkelsen marked this pull request as ready for review November 3, 2026 17:30
@harryterkelsen harryterkelsen added the CICD Run CI/CD label Nov 3, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request implements FragmentShader.getImageSampler for the web engine, aligning its behavior with the native engine. It refactors EngineFragmentShader to accept and store ShaderData, allowing it to resolve image sampler indices directly in the frontend via a new EngineImageSamplerSlot class. The backend-specific getImageSampler implementations in CanvasKit and Skwasm have been removed. Additionally, comprehensive unit tests have been added to verify sampler index resolution, error handling, and image lifetime tracking. I have no feedback to provide.

mdebbar
mdebbar previously approved these changes Nov 4, 2026
@mdebbar mdebbar added autosubmit Merge PR when tree becomes green via auto submit App and removed autosubmit Merge PR when tree becomes green via auto submit App labels Nov 5, 2026
@harryterkelsen harryterkelsen added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 5, 2026
@auto-submit
auto-submit Bot added this pull request to the merge queue Nov 5, 2026
Merged via the queue into flutter:master with commit 8c1cad1 Nov 5, 2026
29 checks passed
@flutter-dashboard flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 5, 2026
auto-submit Bot pushed a commit to flutter/packages that referenced this pull request Nov 6, 2026
Roll Flutter from 3623d2d34543 to 09175cdeac89 (61 revisions)

flutter/flutter@3623d2d...09175cd

2026-11-06 [email protected] Roll Skia from ae35b7b2221f to 793b8ac73d4b (3 revisions) (flutter/flutter#196091)
2026-11-06 [email protected] [web] Rasterize scenes at the size passed to `FlutterView.render` (flutter/flutter#196052)
2026-11-06 [email protected] Roll Skia from 4aa043a81e0c to ae35b7b2221f (1 revision) (flutter/flutter#196086)
2026-11-06 [email protected] Roll Fuchsia Linux SDK from Fqe3UlLwAohsPbsCS... to KIc0XZbhLmvDpTluZ... (flutter/flutter#196085)
2026-11-06 [email protected] Allow a zero scale change in InteractiveViewer (flutter/flutter#194949)
2026-11-06 [email protected] Roll Skia from dd5c2553a856 to 4aa043a81e0c (2 revisions) (flutter/flutter#196079)
2026-11-06 [email protected] [web] Keep ImageFilter.blur bounds in equality and description (flutter/flutter#196013)
2026-11-06 [email protected] iOS: Remove unused PlatformViewIOS setup from FlutterPlatformViewsTest (flutter/flutter#196033)
2026-11-06 [email protected] Serialize LoggerTests that mutate the shared Logger (flutter/flutter#196028)
2026-11-06 [email protected] Use reverseDuration for the AnimatedCrossFade size animation (flutter/flutter#194860)
2026-11-05 [email protected] Roll Skia from a5aacd103e68 to dd5c2553a856 (8 revisions) (flutter/flutter#196073)
2026-11-05 [email protected] Fix ListWheelScrollView null check error when it reads itemIndex before content dimensions are set (flutter/flutter#194859)
2026-11-05 [email protected] Allow zero cross axis extent in SliverGridDelegateWithMaxCrossAxisExtent (flutter/flutter#194858)
2026-11-05 [email protected] Revert: Allow color delta tolerance in in-memory fuzzy image comparator (flutter/flutter#196067)
2026-11-05 [email protected] Revert: Mitigate snapshot race in 3D transform test by reducing loop density (flutter/flutter#196066)
2026-11-05 [email protected] Delegate createStream in ResizeImage and ScrollAwareImageProvider (flutter/flutter#194756)
2026-11-05 [email protected] [iOS] Introduce FlutterShell and move thread host and profiler (flutter/flutter#195388)
2026-11-05 [email protected] [web] Support FragmentShader.getImageSampler on CanvasKit and Skwasm (flutter/flutter#195854)
2026-11-05 [email protected] Deprecates setFloat API (flutter/flutter#195505)
2026-11-05 [email protected] [flutter_tools] Remove public GlobalToolContext and globals from runner (flutter/flutter#195561)
2026-11-05 [email protected] Defer TLHC PlatformViewWrapper frame post and avoid initial 1x1 buffer resize (flutter/flutter#195861)
2026-11-05 [email protected] Roll Skia from b5abed66da86 to a5aacd103e68 (17 revisions) (flutter/flutter#196054)
2026-11-05 [email protected] Made `FlutterWindowControllerSizeTest.SizedToContentNotResizable` more robust (flutter/flutter#195845)
2026-11-05 [email protected] Update docs for contributor ladder (flutter/flutter#196011)
2026-11-05 [email protected] [Impeller] Use the transfer stage for the Vulkan readback barrier (flutter/flutter#194991)
2026-11-05 [email protected] Remove Mac mac_unopt builder (flutter/flutter#196027)
2026-11-05 [email protected] Updated Instructions for Determining Gradle Version for `gradle_dists` in CIPD (flutter/flutter#193310)
2026-11-05 [email protected] Move ios_app_with_extensions_test into the tool integration shard (flutter/flutter#195609)
2026-11-05 [email protected] [web] Respect Uint8List view bounds when detecting animated WebP/GIF (flutter/flutter#196010)
2026-11-05 [email protected] Add platform_views_layout to build_tests so iOS/Android build breaks are caught in presubmit (flutter/flutter#192985)
2026-11-05 [email protected] [flutter_tools] Detect macOS TCC permission crashes and provide diagnostic guidance (flutter/flutter#192432)
2026-11-05 [email protected] Roll Packages from 670b30e to 0478162 (15 revisions) (flutter/flutter#196047)
2026-11-05 [email protected] [web] Support Skwasm rendering without bitmap capture (flutter/flutter#195103)
2026-11-05 [email protected] [flutter_tools] Reland fix for local CanvasKit asset paths on Windows (flutter/flutter#195770)
2026-11-05 [email protected] Roll Skia from f96be51af95d to b5abed66da86 (14 revisions) (flutter/flutter#196017)
2026-11-05 [email protected] Split chrome web engine test drone (flutter/flutter#195873)
2026-11-05 [email protected] Roll Dart SDK from c9153304136a to 6623b84628f3 (1 revision) (flutter/flutter#196026)
2026-11-05 [email protected] Roll ICU from 4fe960221710 to a0ea93436c52 (6 revisions) (flutter/flutter#196025)
2026-11-05 [email protected] Add more guidance in README and AGENTS for contributing to flutter_tools (flutter/flutter#195998)
2026-11-05 [email protected] Roll Fuchsia Linux SDK from p0HDXLISPIElJfSz7... to Fqe3UlLwAohsPbsCS... (flutter/flutter#196019)
2026-11-05 [email protected] Roll Dart SDK from e362a23e9738 to c9153304136a (18 revisions) (flutter/flutter#196014)
2026-11-05 [email protected] [Impeller] Fix dilation input bounds when clipping saveLayers (flutter/flutter#195652)
2026-11-05 [email protected] Add `variantOf` to the M3E migration checklist (flutter/flutter#195099)
2026-11-05 [email protected] [flutter_tools] Eliminate globals from remaining subsystem files (flutter/flutter#195555)
2026-11-05 [email protected] Fix gap flipping when dragging variable height reorderable items (flutter/flutter#194478)
2026-11-05 [email protected] [A11y] Send un-merged SemanticsNodes in the same update that first references them (flutter/flutter#195829)
...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD engine flutter/engine related. See also e: labels. platform-web Web applications specifically team-web Owned by Web platform team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Google3 Bug]: [web] FragmentShader.getImageSampler throws UnsupportedError on CanvasKit and Skwasm

2 participants