Import flutter_shaders package by tarrinneal · Pull Request #12583 · flutter/packages

tarrinneal · 2026-08-25T00:56:47Z

⚠️ DO NOT LAND AS NORMAL — DO NOT ADD `autosubmit` ⚠️

Reviewers: Please DO NOT add the `autosubmit` label to this PR. This is an initial repository migration and must be landed manually following the repository transfer process.

Description

This PR imports flutter_shaders into flutter/packages from its original repository:
Source Repository: https://github.com/jonahwilliams/flutter_shaders
The commit history from the original repository was preserved via git subtree/merge up to commit 2802b9e47b.

Reviewer Guide

Note for Reviewers: Please review only the commits authored on top of the initial import (6eb14ba6e2..HEAD), as the prior commits represent the imported history

Summary of Changes Relative to Initial Import

Repository Integration & Metadata:
- Updated pubspec.yaml with the flutter/packages mono-repo repository and issue_tracker URLs, and added topics: [shaders, graphics].
- Added p: flutter_shaders to .github/labeler.yml.
- Added flutter_shaders to the packages table in the root README.md.
- Standardized BSD license headers across all files to match repository conventions (// Copyright 2013 The Flutter Authors).
SDK Constraints & Dependencies:
- Bumped minimum environment SDK constraints in both pubspec.yaml and example/pubspec.yaml to Flutter >=3.38.0 / Dart ^3.10.0.
Dart 3 Base Class Compatibility & Test Fixes:
- set_uniforms: Extracted FloatUniformsSetter as an abstract base class/interface so uniform conversion logic can be tested and extended without implementing ui.FragmentShader (which is a base class in Dart 3 and cannot be implemented outside dart:ui). Kept UniformsSetter non-nullable and backwards-compatible.
- animated_sampler_test: Updated test callbacks from 4 arguments to 3 arguments (expectAsync3) to match the AnimatedSamplerBuilder signature (the offset parameter was removed in 0.0.6).
- Corrected test expectations in setColors w/ premultiply where a zero-alpha color was expected to have non-zero alpha.
Style, Lints, & Docs:
- Added public API documentation across UniformsSetter and ShaderInkFeatureFactory.
- Cleaned up lints (prefer_foreach, control body newlines) and formatted all files with dart format.
Release / Publish Prep:
- Bumped version to 0.1.4 in pubspec.yaml.
- Added a CHANGELOG.md entry describing the package transfer and changes.

Verification

dart run script/tool/bin/flutter_plugin_tools.dart validate --packages flutter_shaders passes.
dart run script/tool/bin/flutter_plugin_tools.dart analyze --packages flutter_shaders passes with 0 issues.
dart run script/tool/bin/flutter_plugin_tools.dart dart-test --packages flutter_shaders passes (all unit and example tests pass).
dart run script/tool/bin/flutter_plugin_tools.dart license-check passes.

Reminder: DO NOT ADD autosubmit.

google-cla · 2026-08-25T00:57:49Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

gemini-code-assist

Code Review

This pull request imports the flutter_shaders package into the repository, providing utilities like AnimatedSampler, ShaderInkFeature, SetUniforms, and ShaderBuilder to simplify working with the FragmentProgram API. Feedback on the implementation highlights a native memory leak in AnimatedSampler due to an undisposed ui.Scene, an incorrect radius calculation in ShaderInkFeature that ignores the tap position, and an optimization opportunity in ShaderBuilder to prevent redundant concurrent asset loading.

gemini-code-assist · 2026-08-25T00:57:57Z

+    return builder.build().toImageSync(
+      (pixelRatio * bounds.width).ceil(),
+      (pixelRatio * bounds.height).ceil(),
+    );


The ui.Scene returned by builder.build() is a native resource that must be explicitly disposed to avoid memory leaks. Since _buildChildScene is called on every frame of an animation, this will cause a continuous native memory leak. Store the scene in a local variable and dispose it in a finally block.

Suggested change

return builder.build().toImageSync(

(pixelRatio * bounds.width).ceil(),

(pixelRatio * bounds.height).ceil(),

);

final ui.Scene scene = builder.build();

try {

return scene.toImageSync(

(pixelRatio * bounds.width).ceil(),

(pixelRatio * bounds.height).ceil(),

);

} finally {

scene.dispose();

}

gemini-code-assist · 2026-08-25T00:57:57Z

+  final Size size = rectCallback != null ? rectCallback().size : referenceBox.size;
+  final double d1 = size.bottomRight(Offset.zero).distance;
+  final double d2 = (size.topRight(Offset.zero) - size.bottomLeft(Offset.zero)).distance;
+  return math.max(d1, d2) / 2.0;


The _getTargetRadius function calculates the target radius as half of the diagonal of the bounding box, completely ignoring the tap position. If a user taps near a corner or edge, the splash will not expand enough to cover the entire widget. To ensure the splash covers the entire widget, the target radius should be the maximum distance from the tap position to the four corners of the bounding box.

final Size size = rectCallback != null ? rectCallback().size : referenceBox.size; final double d1 = position.distance; final double d2 = (position - size.topRight(Offset.zero)).distance; final double d3 = (position - size.bottomLeft(Offset.zero)).distance; final double d4 = (position - size.bottomRight(Offset.zero)).distance; return math.max(math.max(d1, d2), math.max(d3, d4));

gemini-code-assist · 2026-08-25T00:57:57Z

+  static final Map<String, ui.FragmentProgram> _shaderCache = <String, ui.FragmentProgram>{};
+
+  @override
+  void initState() {
+    super.initState();
+    _loadShader(widget.assetKey);
+  }
+
+  @override
+  void didUpdateWidget(covariant ShaderBuilder oldWidget) {
+    super.didUpdateWidget(oldWidget);
+    if (oldWidget.assetKey != widget.assetKey) {
+      _loadShader(widget.assetKey);
+    }
+  }
+
+  void _loadShader(String assetKey) {
+    if (_shaderCache.containsKey(assetKey)) {
+      program = _shaderCache[assetKey];
+      shader = program!.fragmentShader();
+      return;
+    }
+
+    ui.FragmentProgram.fromAsset(assetKey).then(
+      (ui.FragmentProgram program) {
+        if (!mounted) {
+          return;
+        }
+        setState(() {
+          this.program = program;
+          shader = program.fragmentShader();
+          _shaderCache[assetKey] = program;
+        });
+      },
+      onError: (Object error, StackTrace stackTrace) {
+        FlutterError.reportError(FlutterErrorDetails(exception: error, stack: stackTrace));
+      },
+    );
+  }


If multiple ShaderBuilder widgets with the same assetKey are initialized concurrently before the first one finishes loading, they will all trigger redundant ui.FragmentProgram.fromAsset calls. We can optimize this by keeping a map of pending futures to share the loading process, while still caching the completed FragmentProgram for synchronous access on subsequent builds.

static final Map<String, ui.FragmentProgram> _shaderCache = <String, ui.FragmentProgram>{}; static final Map<String, Future<ui.FragmentProgram>> _pendingLoads = <String, Future<ui.FragmentProgram>>{}; @override void initState() { super.initState(); _loadShader(widget.assetKey); } @override void didUpdateWidget(covariant ShaderBuilder oldWidget) { super.didUpdateWidget(oldWidget); if (oldWidget.assetKey != widget.assetKey) { _loadShader(widget.assetKey); } } void _loadShader(String assetKey) { if (_shaderCache.containsKey(assetKey)) { program = _shaderCache[assetKey]; shader = program!.fragmentShader(); return; } final Future<ui.FragmentProgram> future = _pendingLoads.putIfAbsent( assetKey, () => ui.FragmentProgram.fromAsset(assetKey), ); future.then( (ui.FragmentProgram loadedProgram) { _shaderCache[assetKey] = loadedProgram; _pendingLoads.remove(assetKey); if (!mounted) { return; } setState(() { program = loadedProgram; shader = loadedProgram.fragmentShader(); }); }, onError: (Object error, StackTrace stackTrace) { _pendingLoads.remove(assetKey); FlutterError.reportError(FlutterErrorDetails(exception: error, stack: stackTrace)); }, ); }

tarrinneal · 2026-08-27T04:55:23Z

The failing golden test was generated with material 2, the material 3 version is not very interesting. I can swap them, but it might be better to find something better maybe?

tarrinneal · 2026-08-27T04:56:33Z

stuartmorgan-g · 2026-09-03T18:31:06Z

The failing golden test was generated with material 2, the material 3 version is not very interesting. I can swap them, but it might be better to find something better maybe?

It's not clear to me exactly what it's intended to test. Let's just swap in the current golden, and the new owners can decide if they want to adjust the test later.

stuartmorgan-g

The changes relative to the initial import all LGTM. Thanks for tackling that test class implements issue with the refactor!

…y frame

Fixes flutter#12

Fixes flutter#14

Imports flutter_shaders into the repository and updates it to conform to repository conventions: - Updates package metadata and repository URLs in pubspec.yaml. - Adds topics (shaders, graphics) in pubspec.yaml. - Updates SDK constraints to Flutter >=3.38.0 and Dart ^3.10.0. - Adds flutter_shaders to repository README.md and .github/labeler.yml. - Removes standalone GitHub Actions workflows and pubspec.lock. - Standardizes license headers across source, example, test, and shader files. - Adds FloatUniformsSetter interface for configuring float uniforms. - Adds comprehensive documentation comments for public APIs. - Fixes analysis warnings and formats code according to repo style. - Updates test harness in test/set_uniforms_test.dart to avoid mocking base classes. - Updates golden files and test configuration for platform compatibility. - Bumps package version to 0.1.4 and updates CHANGELOG.md.

@example

flutter/packages@7660d46...54706bd 2026-10-08 [email protected] [image_picker_ios] Return an error for undecodable image data (flutter/packages#12267) 2026-10-07 [email protected] [flutter shaders] update min flutter version (flutter/packages#13160) 2026-10-07 [email protected] Import flutter_shaders package (flutter/packages#12583) 2026-10-07 [email protected] [material_ui] Migrate M3 Typography template to use new gen_defaults (flutter/packages#13074) 2026-10-07 [email protected] Sync release-material_ui-1.6.0 to main (flutter/packages#13149) 2026-10-07 [email protected] [pigeon] Fix native interop (JNI) calls in minified Android release builds (flutter/packages#13151) 2026-10-06 [email protected] [material_ui] Migrate ListTile and SwitchListTile API doc snippets to {@example} (batch 10) (flutter/packages#13097) 2026-10-06 [email protected] Sync release-cupertino_ui-1.1.2 to main (flutter/packages#13150) 2026-10-06 [email protected] [material_ui] Fix `TabBar` assertion to allow `indicatorWeight: 0` with a themed `indicator` (flutter/packages#12696) 2026-10-06 [email protected] [material_ui] Fix time picker input validation for 24-hour locales (flutter/packages#13033) 2026-10-06 [email protected] [material_ui] Migrate Checkbox, CheckboxListTile, Radio, and RadioListTile API doc snippets to {@example} (batch 9) (flutter/packages#13112) 2026-10-06 [email protected] [quick_actions_android] Return null from getLaunchAction when no activity is attached (flutter/packages#12331) If this roll has caused a breakage, revert this CL and set the roller to dry run mode using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: 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

@example

flutter/packages@7660d46...54706bd 2026-10-08 [email protected] [image_picker_ios] Return an error for undecodable image data (flutter/packages#12267) 2026-10-07 [email protected] [flutter shaders] update min flutter version (flutter/packages#13160) 2026-10-07 [email protected] Import flutter_shaders package (flutter/packages#12583) 2026-10-07 [email protected] [material_ui] Migrate M3 Typography template to use new gen_defaults (flutter/packages#13074) 2026-10-07 [email protected] Sync release-material_ui-1.6.0 to main (flutter/packages#13149) 2026-10-07 [email protected] [pigeon] Fix native interop (JNI) calls in minified Android release builds (flutter/packages#13151) 2026-10-06 [email protected] [material_ui] Migrate ListTile and SwitchListTile API doc snippets to {@example} (batch 10) (flutter/packages#13097) 2026-10-06 [email protected] Sync release-cupertino_ui-1.1.2 to main (flutter/packages#13150) 2026-10-06 [email protected] [material_ui] Fix `TabBar` assertion to allow `indicatorWeight: 0` with a themed `indicator` (flutter/packages#12696) 2026-10-06 [email protected] [material_ui] Fix time picker input validation for 24-hour locales (flutter/packages#13033) 2026-10-06 [email protected] [material_ui] Migrate Checkbox, CheckboxListTile, Radio, and RadioListTile API doc snippets to {@example} (batch 9) (flutter/packages#13112) 2026-10-06 [email protected] [quick_actions_android] Return null from getLaunchAction when no activity is attached (flutter/packages#12331) If this roll has caused a breakage, revert this CL and set the roller to dry run mode using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: 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

tarrinneal requested a review from stuartmorgan-g August 25, 2026 00:56

flutter-dashboard Bot added the CICD Run CI/CD label Aug 25, 2026

gemini-code-assist Bot reviewed Aug 25, 2026

View reviewed changes

stuartmorgan-g approved these changes Sep 3, 2026

View reviewed changes

tarrinneal force-pushed the import-flutter-shaders branch from 80eae96 to 6021657 Compare September 10, 2026 01:07

jonahwilliams and others added 21 commits September 9, 2026 19:26

First commit

257ad69

Add pixelation shader

4518b86

update workflow

21373fd

++

fe86847

++

d75e54c

switch to flutter runtime effect

7592479

Fix docs for fragment shader breaking changes

b65fcbb

Add support for configuring inkwell shader

05b4482

update workflows

dff05dc

format

7b41c66

Update inkwell_test.dart

3e6bbac

Call AnimatedSampler.builder from Layer.addToScene to update ever…

bf298fd

…y frame

Address review

6699651

Fixup test

0c91787

Add license header

8f4d119

Use single layer

3561533

update changelog and version

99e41d8

fix offset transforming animated sampler children off the screen

aa1032c

Update sampler.frag

d17137a

++

b592357

example with adjustable sampler

d808860

Jonah Williams and others added 18 commits September 9, 2026 19:26

++

520cf97

Update URLs

888ea52

Update CHANGELOG.md

0a090bc

Bump versions for publishing

35edca7

Resolved issues errors when enabled=false

0bf7b6e

Fixes flutter#12

Resolves errors when the target widget is empty

7394af1

Fixes flutter#14

Adjust enabled check per feedback

47f9b43

update for release

6c5dfab

feat: add uniform setter

b2a8712

docs

17208c3

dart format

d703f0a

add premultiply option

0a04846

update example

8f8d8b7

uh

1e70dd7

Publish prep.

a85f2ed

Fix pixelation shader not compiling

8c7a00d

update version.

65395f2

tarrinneal force-pushed the import-flutter-shaders branch from 6021657 to f458c13 Compare September 10, 2026 02:26

tarrinneal merged commit a80fb63 into flutter:main Oct 7, 2026
13 checks passed

github-actions Bot added the p: flutter_shaders label Oct 7, 2026

Navigation Menu

Repository navigation

Import flutter_shaders package - #12583

Import flutter_shaders package#12583
tarrinneal merged 39 commits into
flutter:mainfrom
tarrinneal:import-flutter-shaders

tarrinneal commented Aug 25, 2026

Uh oh!

google-cla Bot commented Aug 25, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Aug 25, 2026

Uh oh!

gemini-code-assist Bot Aug 25, 2026

Uh oh!

gemini-code-assist Bot Aug 25, 2026

Uh oh!

tarrinneal commented Aug 27, 2026

Uh oh!

tarrinneal commented Aug 27, 2026

Uh oh!

stuartmorgan-g commented Sep 3, 2026

Uh oh!

stuartmorgan-g left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

tarrinneal commented Aug 25, 2026

⚠️ DO NOT LAND AS NORMAL — DO NOT ADD autosubmit ⚠️

Reviewers: Please DO NOT add the autosubmit label to this PR. This is an initial repository migration and must be landed manually following the repository transfer process.

Description

Reviewer Guide

Summary of Changes Relative to Initial Import

Verification

Uh oh!

google-cla Bot commented Aug 25, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Aug 25, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Aug 25, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Aug 25, 2026

Choose a reason for hiding this comment

Uh oh!

tarrinneal commented Aug 27, 2026

Uh oh!

tarrinneal commented Aug 27, 2026

Uh oh!

stuartmorgan-g commented Sep 3, 2026

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

⚠️ DO NOT LAND AS NORMAL — DO NOT ADD `autosubmit` ⚠️

Reviewers: Please DO NOT add the `autosubmit` label to this PR. This is an initial repository migration and must be landed manually following the repository transfer process.