API Reference > frontend-devtools > Effects > ConvolutionEffect ConvolutionEffect Class Beta Adds one of a collection of "convolution kernels" that alter a Viewport's image by blending neighboring pixels. Based on https://webglfundamentals.org/webgl/lessons/webgl-image-processing-continued.html Extends AddEffectTool Extended by GaussianBlurEffect UnsharpenEffect EmbossEffect SharpenEffect SharpnessEffect EdgeDetectionEffect Methods Name Description constructor(..._args: any[]): ConvolutionEffect defineEffect(builder: ScreenSpaceEffectBuilder): void Protected Add uniforms, varyings, etc. Inherited methods Name Inherited from Description parseAndRun(..._args: string[]): boolean AddEffectTool Run this instance of a tool using a series of string arguments. run(): boolean AddEffectTool register(namespace?: I18NNamespace, i18n?: I18N): void Static AddEffectTool Register this Tool class with the ToolRegistry. Properties Name Type Description matrix Accessor ProtectedAbstractReadOnly number[] maxArgs Accessor StaticReadOnly number minArgs Accessor StaticReadOnly number source Accessor ProtectedReadOnly { fragment: string, vertex: string } textureCoordFromPosition Accessor ProtectedReadOnly boolean Inherited properties Name Type Inherited from Description description Accessor ReadOnly string AddEffectTool Get the localized description string from this Tool's class description Accessor StaticReadOnly string AddEffectTool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" fromits registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,AddEffectTool.flyover is returned. effectName Accessor ProtectedAbstractReadOnly string AddEffectTool Name of effect as used in keyins like fdt effect add. Ideally one word. englishKeyin Accessor StaticReadOnly string AddEffectTool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" fromits registered Namespace (e.g. "en/MyApp.json"). flyover Accessor ReadOnly string AddEffectTool Get the localized flyover string from this Tool's class flyover Accessor StaticReadOnly string AddEffectTool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" fromits registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,AddEffectTool.keyin is returned. hidden Static boolean AddEffectTool If true, this Tool will not appear in the list from getToolList. i18n Static I18N AddEffectTool The internationalization services instance used to translate strings from the namespace. iconSpec Accessor ReadOnly string AddEffectTool Get the iconSpec from this Tool's class. iconSpec Static string AddEffectTool The icon for this Tool. keyin Accessor ReadOnly string AddEffectTool Get the localized keyin string from this Tool's class keyin Accessor StaticReadOnly string AddEffectTool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" fromits registered Namespace (e.g. "en/MyApp.json"). namespace Static I18NNamespace AddEffectTool The I18NNamespace that provides localized strings for this Tool. toolId Accessor ReadOnly string AddEffectTool Get the toolId string for this Tool class. This string is used to identify the Tool in the ToolRegistry and is used to localizethe keyin, description, etc. from the current locale. toolId Static string AddEffectTool The unique string that identifies this tool. Defined in frontend-devtools/src/effects/Convolution.ts Line 16 Last Updated: 11 June, 2024