Skip to content

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.

Sign up for GitHub

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

Merged
auto-submit merged 6 commits into from
Jan 5, 2026
Merged

docs: Impeller usage requirements for ImageFilter.shader and isShader… #179387

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
addd531
docs: Impeller usage requirements for ImageFilter.shader and isShader…
gowsikraja Dec 3, 2025
fb4dae4
gemini-code-assist suggestion
gowsikraja Dec 3, 2025
dd9731c
Review commets changes.
gowsikraja Dec 9, 2025
b42ab4e
Review comments changes+
gowsikraja Dec 11, 2025
ecd72dc
Snippet analyzer issue fixed
gowsikraja Dec 22, 2025
d37fe11
Whitespace issue fixed
gowsikraja Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions engine/src/flutter/lib/ui/painting.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4334,6 +4334,20 @@ abstract class ImageFilter {

/// Creates an image filter from a [FragmentShader].
///
/// > [!WARNING]
/// > This API is only supported when using the Impeller rendering engine.
/// > On other backends, an [UnsupportedError] will be thrown.
///
/// > To check at runtime whether this API is supported, use [isShaderFilterSupported].
///
/// Example usage:
///
/// ```dart
/// if (ui.ImageFilter.isShaderFilterSupported) {
/// // Use the filter...
/// }
/// ```
///
/// The fragment shader provided here has additional requirements to be used
/// by the engine for filtering. The first uniform value must be a vec2, this
/// will be set by the engine to the size of the bound texture. There must
Expand Down Expand Up @@ -4369,10 +4383,6 @@ abstract class ImageFilter {
/// }
///
/// ```
///
/// This API is only supported when using the Impeller rendering engine. On
/// other backends a [UnsupportedError] will be thrown. To check at runtime
/// whether this API is suppored use [isShaderFilterSupported].
factory ImageFilter.shader(FragmentShader shader) {
if (!_impellerEnabled) {
throw UnsupportedError('ImageFilter.shader only supported with Impeller rendering engine.');
Expand All @@ -4395,6 +4405,10 @@ abstract class ImageFilter {
}

/// Whether [ImageFilter.shader] is supported on the current backend.
///
/// > [!WARNING]
/// > This property will only return true when the Impeller rendering engine is enabled.
/// > Attempting to create an [ImageFilter.shader] when this property is `false` will throw an [UnsupportedError].
static bool get isShaderFilterSupported => _impellerEnabled;

// Converts this to a native DlImageFilter. See the comments of this method in
Expand Down