API Reference › frontend-devtools› Effects › FlipImageEffect

FlipImageEffect Class

An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect. It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.

Extends

Methods

Name Description
constructor(..._args: any[]): FlipImageEffect    
defineEffect(builder: ScreenSpaceEffectBuilder): void Protected Add uniforms, varyings, etc.  

Inherited methods

Name Inherited from Description
parseAndRun(..._args: string[]): Promise<boolean> AddEffectTool Run this instance of a tool using a series of string arguments.
run(): Promise<boolean> AddEffectTool  
register(namespace?: string): void Static AddEffectTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
effectName Accessor Protected ReadOnly string Name of effect as used in keyins like fdt effect add.  
source Accessor Protected ReadOnly { fragment: string, sampleSourcePixel: string, vertex: string } vertex, fragment, and optional sampleSourcePixel GLSL snippets.  
textureCoordFromPosition Accessor Protected ReadOnly boolean Whether the fragment shader should include built-in textureCoordFromPosition function.  
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string AddEffectTool Get the localized description string from this Tool's class
description Accessor Static ReadOnly string AddEffectTool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
flyover is returned.
englishKeyin Accessor Static ReadOnly string AddEffectTool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
flyover Accessor ReadOnly string AddEffectTool Get the localized flyover string from this Tool's class
flyover Accessor Static ReadOnly string AddEffectTool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
keyin is returned.
hidden Static boolean AddEffectTool If true, this Tool will not appear in the list from ToolRegistry.getToolList.
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 Static ReadOnly string AddEffectTool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
maxArgs Accessor Static ReadOnly undefined | number AddEffectTool The maximum number of arguments allowed by parseAndRun, or undefined if there is no maximum.
If subclasses override parseAndRun, they should also override this method to indicate the maximum
number of arguments their implementation expects.
minArgs Accessor Static ReadOnly number AddEffectTool The minimum number of arguments allowed by parseAndRun. If subclasses override parseAndRun, they should also
override this method to indicate the minimum number of arguments their implementation expects. UI controls can use
this information to ensure the tool has enough information to execute.
namespace Static string AddEffectTool The namespace 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 localize
the keyin, description, etc. from the current locale.

Defined in

Last Updated: 09 May, 2024