Skip to content

[framework] document backdropfilter antipattern#109340

Merged
auto-submit[bot] merged 9 commits intoflutter:masterfrom
jonahwilliams:add_bdf_comment
Aug 11, 2022
Merged

[framework] document backdropfilter antipattern#109340
auto-submit[bot] merged 9 commits intoflutter:masterfrom
jonahwilliams:add_bdf_comment

Conversation

@jonahwilliams
Copy link
Contributor

@jonahwilliams jonahwilliams commented Aug 10, 2022

Backdrop filter does not cache the results of the filter application, which leads to terrible performance on blur filters. Document a common anti-pattern and its alternative

@flutter-dashboard flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label Aug 10, 2022
goderbauer
goderbauer reviewed Aug 10, 2022
View reviewed changes
packages/flutter/lib/src/widgets/basic.dart Outdated
///
/// ```
///
/// Instead consider the following:
Copy link
Member

@goderbauer goderbauer Aug 10, 2022

Choose a reason for hiding this comment

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

I believe this will not render correctly in dart doc as dartdoc will pull all the regular text up front before any code blocks.

Copy link
Contributor Author

@jonahwilliams jonahwilliams Aug 10, 2022

Choose a reason for hiding this comment

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

Should I just do two separate tool blocks then?

goderbauer
goderbauer approved these changes Aug 10, 2022
View reviewed changes
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM

packages/flutter/lib/src/widgets/basic.dart Outdated
/// is generally simpler and the performance will be improved dramatically.
///
/// ```dart
/// return Stack(
Copy link
Member

@goderbauer goderbauer Aug 10, 2022

Choose a reason for hiding this comment

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

I would add a comment inside the dart block here pointing out explicitly that this is the inefficient implementation. To make sure that nobody accidentally copies this bad example.

Copy link
Contributor Author

@jonahwilliams jonahwilliams Aug 10, 2022

Choose a reason for hiding this comment

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

ahh good idea 😓

flar
flar reviewed Aug 10, 2022
View reviewed changes
packages/flutter/lib/src/widgets/basic.dart Outdated
/// {@tool snippet}
///
/// This example shows how the common case of applying a [BackdropFilter] blur
/// to a single child can be replaced with an [ImageFiltered] widget. This code
Copy link
Contributor

@flar flar Aug 10, 2022

Choose a reason for hiding this comment

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

single ancestor/sibling? It's a child of the Stack that one would use, but it is an ancestor or older sibling of the BDF itself.

Copy link
Contributor Author

@jonahwilliams jonahwilliams Aug 10, 2022

Choose a reason for hiding this comment

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

Done

@jonahwilliams jonahwilliams added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 11, 2022
@auto-submit auto-submit bot merged commit 6e92f87 into flutter:master Aug 11, 2022
@jonahwilliams jonahwilliams deleted the add_bdf_comment branch August 11, 2022 17:31
This was referenced Aug 12, 2022
Closed
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
2e58613 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
cf6d07d 
…ter#109340)
This was referenced Aug 12, 2022
Closed
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
53eea00 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
007cde7 
…ter#109340)
This was referenced Aug 12, 2022
Closed
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
7c6968b 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
7e2587a 
…ter#109340)
This was referenced Aug 12, 2022
Closed
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
6b7e0e6 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
36df507 
…ter#109340)
This was referenced Aug 12, 2022
Closed
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
febefca 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 12, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
544fafc 
…ter#109340)
This was referenced Aug 13, 2022
Closed
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 13, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
c584c25 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 13, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
7a5560f 
…ter#109340)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 13, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 13, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
7f36c4e 
…ter#109340)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 13, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 13, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
abbbe30 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
489c681 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 14, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
555deea 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
3b15bf9 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 14, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
cd12d30 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 14, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
4b0c424 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
22d8749 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
716aa1c 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
4511b0b 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
d00f438 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
bfd8d85 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
a06d4a2 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
6b85ecb 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
e0a3b2f 
…ter#109340)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 15, 2022
@engine-flutter-autoroll
6e92f87 [framework] document backdropfilter antipattern (flutter/flut…
4648861 
…ter#109340)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@flar flar flar left review comments

@goderbauer goderbauer goderbauer approved these changes

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jonahwilliams @goderbauer @flar