[iOS] Inject DisplayLinkManager into FlutterMetalLayer#189752
Conversation
Follow-up to the DisplayLinkManager singleton migration (flutter#189492). FlutterMetalLayer read FlutterDisplayLinkManager.shared directly in four places when seeding and re-seeding its own CADisplayLink's preferred frame rate range. FlutterMetalLayer can't take a constructor parameter since it's a CALayer subclass, and every instance is created implicitly by UIKit via `+layerClass` returning `[FlutterMetalLayer class]` (see rendering_api_selection.mm and the various +layerClass overrides), which always calls the parameterless `-init`. There's no callsite anywhere in the tree that does `[[FlutterMetalLayer alloc] init]` directly, so unlike VsyncWaiterIOS/FlutterKeyboardInsetManager there's no initializer to extend, and no common-initialization method to fall back on; just -init itself. This adds a _displayLinkManager ivar, which we wire up from FlutterDisplayLinkManager.shared at the top of -init, and switches the four reads (the initial setMaxRefreshRate:forceMax: call, the maxRefreshRateEnabledOnIPhone guard, and the two re-seeds in onDisplayLink: and presentOnMainThread:) to read from it instead. I deliberately didn't add this as a property on the class: FlutterMetalLayer.h's header comment states properties and methods "must exactly match those in the CAMetalLayer interface declaration" — it deliberately masquerades as CAMetalLayer (which you can see in -isKindOfClass:), so there's no point in increasing its API surface with this. Added the ivar in a private class extension alongside the existing _preferredDevice and _drawableSize. No semantic change, just a refactoring, so no change to the tests. Issue: flutter#175879 Issue: flutter#181684
|
It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging. If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group. |
There was a problem hiding this comment.
Code Review
This pull request introduces an instance variable _displayLinkManager in FlutterMetalLayer to cache the shared instance of FlutterDisplayLinkManager. The code is updated to reference this cached instance instead of repeatedly accessing FlutterDisplayLinkManager.shared. There are no review comments, and I have no feedback to provide.
|
Removed auto-submit to wait on test exemption. |
|
test-exempt: code refactor with no semantic change |
flutter/flutter@1ac2e82...2a2a79d 2026-07-22 [email protected] Clear cached directional focus history on a non-directional focus request (flutter/flutter#187957) 2026-07-22 [email protected] ci: Include root pubspec.yaml in pub cache key (flutter/flutter#189826) 2026-07-22 [email protected] Remove codecov badge from README (flutter/flutter#189728) 2026-07-22 [email protected] Clean android engine/embedding tests (flutter/flutter#189276) 2026-07-22 [email protected] Add barrierBuilder support to showDialog and showGeneralDialog (flutter/flutter#187992) 2026-07-22 [email protected] Fix Mockito dynamic agent loading warnings in Robolectric tests (flutter/flutter#189804) 2026-07-22 [email protected] [iOS] Remove dead RasterThreadMerger plumbing from platform views (flutter/flutter#189753) 2026-07-22 [email protected] Add OverlayPortal.overlayChildLayoutBuilder sample (flutter/flutter#188930) 2026-07-22 [email protected] Automate recurring tasks via workflows - localizations (flutter/flutter#189750) 2026-07-21 [email protected] [iOS] Remove dead parameters and no-op overrides (flutter/flutter#189754) 2026-07-21 [email protected] [iOS] Inject DisplayLinkManager into FlutterViewController (flutter/flutter#189764) 2026-07-21 [email protected] Support custom BoxBorder animation in BoxDecoration (flutter/flutter#186348) 2026-07-21 [email protected] Rename CpuArch.x86_64 to CpuArch.x64 (flutter/flutter#189478) 2026-07-21 [email protected] Roll Skia from 569534e9fa59 to 5e183e5aeac5 (3 revisions) (flutter/flutter#189795) 2026-07-21 [email protected] Roll Dart SDK from 3b2f5ad7718d to 1e65011ee004 (4 revisions) (flutter/flutter#189791) 2026-07-21 [email protected] Run delete-bot-branches.yaml on `pull_request_target` instead of `pull_request` so that we can access secrets. (flutter/flutter#189793) 2026-07-21 [email protected] Batch release directory correction (flutter/flutter#189738) 2026-07-21 [email protected] [flutter_test][Test cross imports] Move TestWidgetsApp to flutter_test (flutter/flutter#189435) 2026-07-21 [email protected] Fix null-deref/double-dispose in StretchingOverscrollIndicator (#189589) (flutter/flutter#189667) 2026-07-21 [email protected] Roll Packages from 611899b to 8260a1e (10 revisions) (flutter/flutter#189782) 2026-07-21 [email protected] [iOS] Inject DisplayLinkManager into FlutterMetalLayer (flutter/flutter#189752) 2026-07-21 [email protected] Derive the SkImage size used by ImageEncodingImpeller::ConvertDlImageToSkImage from the size of the underlying texture, not the size of the DlImage (flutter/flutter#189739) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: 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
Follow-up to the DisplayLinkManager singleton migration (#189492). FlutterMetalLayer read FlutterDisplayLinkManager.shared directly in four places when seeding and re-seeding its own CADisplayLink's preferred frame rate range.
FlutterMetalLayer can't take a constructor parameter since it's a CALayer subclass, and every instance is created implicitly by UIKit via
+layerClassreturning[FlutterMetalLayer class](see rendering_api_selection.mm and the various +layerClass overrides), which always calls the parameterless-init. There's no callsite anywhere in the tree that does[[FlutterMetalLayer alloc] init]directly, so unlike VsyncWaiterIOS/FlutterKeyboardInsetManager there's no initializer to extend, and no common-initialization method to fall back on; just -init itself.This adds a _displayLinkManager ivar, which we wire up from FlutterDisplayLinkManager.shared at the top of -init, and switches the four reads (the initial setMaxRefreshRate:forceMax: call, the maxRefreshRateEnabledOnIPhone guard, and the two re-seeds in onDisplayLink: and presentOnMainThread:) to read from it instead.
I deliberately didn't add this as a property on the class: FlutterMetalLayer.h's header comment states properties and methods "must exactly match those in the CAMetalLayer interface declaration" — it deliberately masquerades as CAMetalLayer (which you can see in -isKindOfClass:), so there's no point in increasing its API surface with this. Added the ivar in a private class extension alongside the existing _preferredDevice and _drawableSize.
No semantic change, just a refactoring, so no change to the tests.
Issue: #175879
Issue: #181684
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-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.