Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change default TileMode for blur ImageFilter objects to null #55552

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

flar
Copy link
Contributor

@flar flar commented Oct 1, 2024

Fixes flutter/flutter#154935

Historically ImageFilter.blur supported setting a TileMode and had a default mode of clamp, but few developers actually set the value and the default was not appropriate for some common uses like as a backdrop filter where the clamp mode produces flashing when scrolling high frequency pixel content underneath a blurred title bar.

This PR removes the default tile mode instead allowing a null value as the default which will allow the engine to use an appropriate context-dependent default tile mode depending on the action being performed. Typically:

  • decal for rendering operations and saveLayers and ImageFilterLayer
  • clamp for image operations
  • mirror for backdrop filters

@flar flar force-pushed the ui-blur-image-filter-null-default-tile-mode branch from 4c5d450 to 56a2fcb Compare October 1, 2024 19:56
Copy link
Member

@jonahwilliams jonahwilliams left a comment

Choose a reason for hiding this comment

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

I'm not sure that I followed the discussion on clamp for image operations vs decal. I think it can be a bit fuzzy whether or not something is an image operation, because different paint settings (like mask filter) can lead to something ending up as a saveLayer more or less.

We also need to change this for the web engine.

@flar
Copy link
Contributor Author

flar commented Oct 3, 2024

I'm not sure that I followed the discussion on clamp for image operations vs decal. I think it can be a bit fuzzy whether or not something is an image operation, because different paint settings (like mask filter) can lead to something ending up as a saveLayer more or less.

We also need to change this for the web engine.

drawImage(Rect/Nine/Atlas) are image operations.
saveLayer is not.

I figure that saveLayer is a collection of rendering and rendering operations have space all around them out to infinity so they should reflect that in the choice of mode.

drawImage et al, the source is a physical image that has edges. Within the bounds of the image it should be smeared from its contents. Granted it will spill over the theoretical "frame" which they might clip out.

If we take some other operation and render it to a temp layer then we need to respect whatever tile mode was chosen for the content even as we perform that operation (whether it is a defaulted tile mode or whether they explicitly set it), so I don't think that case should affect the defaults. It's an implementation detail. The defaults were chosen based on the base operation itself and what is happening...

@chinmaygarde
Copy link
Member

Triage: This is waiting on an update to the web engine.

@flar flar force-pushed the ui-blur-image-filter-null-default-tile-mode branch from 56a2fcb to 1b20a34 Compare October 21, 2024 23:51
@github-actions github-actions bot added the platform-web Code specifically for the web engine label Oct 21, 2024
@flar flar requested a review from yjbanov October 21, 2024 23:55
@flar
Copy link
Contributor Author

flar commented Oct 21, 2024

I've plumbed most of the web stuff, but haven't yet gotten it all working. I think I got canvaskit renderer to accept the defaults, but it doesn't implement the tile mode in saveLayer so you can't really tell. web gives me some sort of "null canvas" and "width/height > 0" assertion failure. I haven't tried with skwasm as I don't have that building in my local engine case...

@flar flar force-pushed the ui-blur-image-filter-null-default-tile-mode branch from c5ca242 to 30e02d2 Compare October 23, 2024 02:00
@flar
Copy link
Contributor Author

flar commented Oct 23, 2024

I'm hoping this last commit fixes all of the tests, but I still want to have a rendering test for the various blur tile mode values to catch specific regressions.

@flutter-dashboard
Copy link

Golden file changes have been found for this pull request. Click here to view and triage (e.g. because this is an intentional change).

If you are still iterating on this change and are not ready to resolve the images on the Flutter Gold dashboard, consider marking this PR as a draft pull request above. You will still be able to view image results on the dashboard, commenting will be silenced, and the check will not try to resolve itself until marked ready for review.

Changes reported for pull request #55552 at sha a0d7867

Copy link
Contributor

@eyebrowsoffire eyebrowsoffire left a comment

Choose a reason for hiding this comment

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

Looks good to me, have just a couple non-blocking requests.

@@ -60,7 +60,7 @@ abstract class SkwasmImageFilter implements SceneImageFilter {
///
/// The handle is deleted immediately after [borrow] returns. The [borrow]
/// function must not store the handle to avoid dangling pointer bugs.
void withRawImageFilter(ImageFilterHandleBorrow borrow);
void withRawImageFilter(ImageFilterHandleBorrow borrow, {ui.TileMode defaultMode = ui.TileMode.clamp});
Copy link
Contributor

Choose a reason for hiding this comment

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

Two things: can you actually call this defaultTileMode to be a bit more clear, and secondly can you modify the doc comment to mention this parameter and what it does?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platform-web Code specifically for the web engine will affect goldens
Projects
None yet
5 participants