API Reference › frontend-devtools› Effects

Effects

Examples of screen-space effects produced by RenderSystem.createScreenSpaceEffectBuilder.

Classes

Name Description  
AddEffectTool Adds a screen-space effect to the selected viewport.  
ClearEffectsTool Removes all screen-space effects from the selected viewport.  
ConvolutionEffect Adds one of a collection of "convolution kernels" that alter a Viewport's image by blending neighboring pixels.  
EdgeDetectionEffect Adds a screen-space edge-detection effect to the selected Viewport.  
EmbossEffect Adds a screen-space emboss effect to the selected Viewport.  
ExplosionEffect This tool applies an explosion particle effect used for testing ParticleCollectionBuilder.  
FlipImageConfig Configure the FlipImageEffect.  
FlipImageEffect An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.  
GaussianBlurEffect Adds a gaussian blur screen-space effect to the selected Viewport.  
LensDistortionConfig Configures the LensDistortionEffect.  
LensDistortionEffect Adds a screen-space effect to the selected Viewport to simulate the lens distortion produced by real-world cameras with very wide fields of view.  
SaturationConfig Configures the SaturationEffect.  
SaturationEffect Adjusts the saturation of colors in a viewport.  
SharpenEffect Adds a screen-space sharpen effect to the selected Viewport.  
SharpnessEffect Adds a screen-space sharpness effect to the selected Viewport.  
SnowDecorator Simulates snowfall in a Viewport using particle effects.  
SnowEffect Toggles a decorator that simulates snow using particle effects.  
UnsharpenEffect Adds a screen-space unsharpen effect to the selected Viewport.  
VignetteConfig Configures the VignetteEffect.  
VignetteEffect Applies a vignette effect to the viewport.  

Global Functions

Name Description  
randomFloat Generate random floating-point number in [min, max).  
randomFloatInRange Generate random floating-point number in [range.low, range.high).  
randomInteger Generate integer in [min, max].  
randomIntegerInRange Generate random integer in [range.low, range.high].  
randomPositionInRange Generate a random position in the specified range.  
refreshViewportsForEffect Requests that any viewport to which the specified effect has been applied redraw its contents.  

Interfaces

Name Description  
SnowParams Parameters controlling how a SnowDecorator works.  
SnowParticle Represents one particle displayed by a SnowDecorator.  

Last Updated: 15 May, 2024