-
Notifications
You must be signed in to change notification settings - Fork 29.8k
docs: Impeller usage requirements for ImageFilter.shader and isShader… #179387
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
docs: Impeller usage requirements for ImageFilter.shader and isShader… #179387
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the API documentation for ImageFilter.shader and isShaderFilterSupported to make the Impeller rendering engine requirement more explicit. The changes move the warning about Impeller to the top of the documentation for ImageFilter.shader and add a similar warning to isShaderFilterSupported, both using a [!WARNING] block. An example of how to use isShaderFilterSupported is also added. I have one minor suggestion to fix a typo in the documentation formatting.
|
LGTM but the analysis is not able to complete successfully. |
|
@chinmaygarde @jason-simmons I am attempting to merge my PR, but I am encountering an issue and am unsure of the root cause. As this is my first contribution to the project, I would appreciate any guidance or assistance you could provide to resolve this. Thanks in advance for your help! |
b90edb5 to
c04fc05
Compare
|
The (See the messages around the Change the lines at https://github.com/flutter/flutter/pull/179387/files#diff-005152dcaaa555ef138ebdd1580cea316c59e82d12563cdb4c8b5bd16c7e6b6dR4314 to something like: |
|
autosubmit label was removed for flutter/flutter/179387, because The base commit of the PR is older than 7 days and can not be merged. Please merge the latest changes from the main into this branch and resubmit the PR. |
39ab447 to
d37fe11
Compare
Summary
This PR improves the API documentation for ImageFilter.shader and isShaderFilterSupported by making the Impeller requirement more explicit and visible.
What was changed
Added an “Important” notice to clearly state that these APIs are only supported with Impeller.
Updated the doc comments to front-load this detail instead of placing it later in the text.
Added cross-reference notes explaining how isShaderFilterSupported relates to Impeller.
Why this change is helpful
Developers frequently run into confusion when using shader-based filters without realizing they require Impeller. This change makes the requirement obvious and easier to discover.
Issue reference
Fixes #178767