Adds switch for sdf rendering plus golden tests#183543
Adds switch for sdf rendering plus golden tests#183543auto-submit[bot] merged 11 commits intoflutter:masterfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a new flag, impeller_use_sdfs, to control the use of Signed Distance Fields (SDFs) for rendering in Impeller. The changes include adding the flag to settings, parsing it from command-line arguments and platform-specific configuration files (like Info.plist on Apple platforms), and plumbing it through to the rendering backend. Additionally, golden tests for MetalSDF are added. My review focuses on ensuring consistency and maintainability. I've identified a few areas for improvement, particularly regarding default flag values on Apple platforms and code duplication in the playground implementation.
| case PlaygroundBackend::kMetal: | ||
| return std::make_unique<PlaygroundImplMTL>(switches); | ||
| case PlaygroundBackend::kMetalSDF: | ||
| switches.flags.use_sdfs = true; | ||
| return std::make_unique<PlaygroundImplMTL>(switches); |
There was a problem hiding this comment.
The logic for PlaygroundBackend::kMetal and PlaygroundBackend::kMetalSDF is very similar and contains duplicated code. You can refactor this to improve maintainability by having the kMetalSDF case set the use_sdfs flag and then fall through to the kMetal case.
| case PlaygroundBackend::kMetal: | |
| return std::make_unique<PlaygroundImplMTL>(switches); | |
| case PlaygroundBackend::kMetalSDF: | |
| switches.flags.use_sdfs = true; | |
| return std::make_unique<PlaygroundImplMTL>(switches); | |
| case PlaygroundBackend::kMetalSDF: | |
| switches.flags.use_sdfs = true; | |
| [[fallthrough]]; | |
| case PlaygroundBackend::kMetal: | |
| return std::make_unique<PlaygroundImplMTL>(switches); |
| settings.warn_on_impeller_opt_out = true; | ||
|
|
||
| NSNumber* nsEnableSDFs = [mainBundle objectForInfoDictionaryKey:@"FLTEnableSDFs"]; | ||
| settings.impeller_use_sdfs = (nsEnableSDFs ? nsEnableSDFs.boolValue : NO); |
There was a problem hiding this comment.
The default value for impeller_use_sdfs is true in settings.h. However, this logic sets it to NO (false) if the FLTEnableSDFs key is missing from the Info.plist, which overrides the intended default. To respect the default from settings.h, you should only modify settings.impeller_use_sdfs if the key is explicitly set in the bundle.
| settings.impeller_use_sdfs = (nsEnableSDFs ? nsEnableSDFs.boolValue : NO); | |
| if (nsEnableSDFs) { | |
| settings.impeller_use_sdfs = nsEnableSDFs.boolValue; | |
| } |
| if (enableSDFs != nil) { | ||
| return enableSDFs.boolValue; | ||
| } | ||
| return NO; |
There was a problem hiding this comment.
This method defaults to returning NO if the FLTEnableSDFs key is not found in the Info.plist. This causes the engine to be launched with --impeller-use-sdfs=false, which overrides the default value of true for this setting from settings.h. To align with the default behavior, this method should return YES when the key is not present.
| return NO; | |
| return YES; |
There was a problem hiding this comment.
nit: Any reason to use ?: above but an if and a return here?
There was a problem hiding this comment.
This is matching the other functions like enableFlutterGPU and enableWideGamut, no reason beyond that.
There was a problem hiding this comment.
Ah, so local consistency rules over global consistency... 👍
Roll Flutter from 732e05dd483c to d117642c18e0 (47 revisions) flutter/flutter@732e05d...d117642 2026-03-17 [email protected] Roll Skia from fa3bb1f60d99 to dba893a44d7a (1 revision) (flutter/flutter#183783) 2026-03-17 [email protected] [ios][pv]fix admob banner scrollable on ios 18.2 (flutter/flutter#183274) 2026-03-17 [email protected] Roll Packages from 0f2eeae to a9d36fb (2 revisions) (flutter/flutter#183782) 2026-03-17 [email protected] Update goldctl version (flutter/flutter#183538) 2026-03-17 [email protected] Roll Skia from 69be1087807b to fa3bb1f60d99 (1 revision) (flutter/flutter#183779) 2026-03-17 [email protected] Roll Dart SDK from 38dedf00c2cd to 30cdd2634429 (1 revision) (flutter/flutter#183778) 2026-03-17 [email protected] Roll Fuchsia Linux SDK from s7rq9m8tH2aZtX-kP... to zYBvfzIH95BY3cCzL... (flutter/flutter#183777) 2026-03-17 [email protected] Roll Skia from 4ea039236580 to 69be1087807b (2 revisions) (flutter/flutter#183772) 2026-03-17 [email protected] Roll Skia from fb402093cfb5 to 4ea039236580 (1 revision) (flutter/flutter#183770) 2026-03-17 [email protected] Roll Skia from d6bc6d17d637 to fb402093cfb5 (8 revisions) (flutter/flutter#183765) 2026-03-17 [email protected] Roll Dart SDK from ff50ab8ecea4 to 38dedf00c2cd (2 revisions) (flutter/flutter#183764) 2026-03-17 [email protected] Wrap EGL image usage in a GObject (flutter/flutter#183539) 2026-03-17 [email protected] Adds platform_view_test_macos_impeller (flutter/flutter#183760) 2026-03-17 [email protected] Adds flush to metal screenshotter. (flutter/flutter#183758) 2026-03-16 [email protected] Add a platform OpenGL context. (flutter/flutter#183715) 2026-03-16 [email protected] Fix formatting, capitalization, and grammar in activation issue template (flutter/flutter#183061) 2026-03-16 [email protected] Roll Dart SDK from 4a6febbf882e to ff50ab8ecea4 (2 revisions) (flutter/flutter#183739) 2026-03-16 [email protected] docs: add code review guidance to CONTRIBUTING.md (flutter/flutter#182778) 2026-03-16 [email protected] Filter 'waiting for customer response' issues from macOS triage (flutter/flutter#183552) 2026-03-16 [email protected] Adds github action to reset cicd when new branches come (flutter/flutter#183675) 2026-03-16 [email protected] Adds macos impeller complex layout performance test (flutter/flutter#183669) 2026-03-16 [email protected] Roll Dart SDK from b74e5b537d71 to 4a6febbf882e (2 revisions) (flutter/flutter#183695) 2026-03-16 [email protected] Use properties to configure leak_tracking and test_randomization_off in .ci.yaml (flutter/flutter#183605) 2026-03-16 [email protected] [flutter_tools] Avoid File.exists and File.stat, as per enforced lint rule (flutter/flutter#183463) 2026-03-16 [email protected] Properly parse URIs for testPath when the host is running on Windows. (flutter/flutter#176881) 2026-03-16 [email protected] Roll Packages from 91f7c33 to 0f2eeae (6 revisions) (flutter/flutter#183730) 2026-03-16 [email protected] Roll Skia from a6ccaf95c6e0 to d6bc6d17d637 (5 revisions) (flutter/flutter#183726) 2026-03-16 [email protected] Roll Fuchsia Linux SDK from WOfyEFkxf9JX26VS-... to s7rq9m8tH2aZtX-kP... (flutter/flutter#183723) 2026-03-15 [email protected] Roll Skia from 34ace196b838 to a6ccaf95c6e0 (2 revisions) (flutter/flutter#183712) 2026-03-14 [email protected] Roll Fuchsia Linux SDK from vAWG8mRvsQHblDBsy... to WOfyEFkxf9JX26VS-... (flutter/flutter#183694) 2026-03-14 [email protected] Roll Skia from 06106120c6bf to 34ace196b838 (1 revision) (flutter/flutter#183677) 2026-03-14 [email protected] Roll Dart SDK from 6a3dc9d4f881 to b74e5b537d71 (2 revisions) (flutter/flutter#183676) 2026-03-14 [email protected] Add some quality of life improvements to the release GitHub workflows. (flutter/flutter#183658) 2026-03-14 [email protected] Fix RouteAware.didPushNext documentation inaccuracy (flutter/flutter#183097) 2026-03-13 [email protected] Adds complex layout impeller startup benchmark (flutter/flutter#183655) 2026-03-13 [email protected] Adds switch for sdf rendering plus golden tests (flutter/flutter#183543) 2026-03-13 [email protected] Made complex_layout_scroll_perf explicitly skia (flutter/flutter#183663) 2026-03-13 [email protected] Update android integration test to match the current android semantics (flutter/flutter#183548) 2026-03-13 [email protected] Roll Skia from 6c0346103c24 to 06106120c6bf (3 revisions) (flutter/flutter#183654) 2026-03-13 [email protected] Roll Dart SDK from d5f6d3c17499 to 6a3dc9d4f881 (1 revision) (flutter/flutter#183652) 2026-03-13 [email protected] Fix PinnedHeaderSliver semantics focus capture (flutter/flutter#179023) 2026-03-13 [email protected] [a11y][android] In Android 16, sendWindowContentChangeEvent when check state changes (flutter/flutter#183606) 2026-03-13 [email protected] Update gradle utils to know about kgp 2.3.10 constraints (flutter/flutter#183416) 2026-03-13 [email protected] Roll Skia from 029229d8be91 to 6c0346103c24 (5 revisions) (flutter/flutter#183648) 2026-03-13 [email protected] Roll Fuchsia Linux SDK from jJbpv4J_tjW-wuKDq... to vAWG8mRvsQHblDBsy... (flutter/flutter#183646) 2026-03-13 [email protected] [flutter_tools] Support flavors and transformers for shaders (flutter/flutter#181889) ...
The golden's for MetalSDF should be identical right now. Then we can get a baseline.
This setup makes the flag available to canvas.cc via
renderer_.GetContext()->GetFlags().use_sdf.fixes #183040
fixes #183042
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot 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.