HypernovaDesktop Components · docs
Binarymission
WPFShaders Library › WaterWaveEffect

WaterWaveEffect

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WPF.Shaders.Library.CustomEffects

A pixel shader effect that rolls a wave across its input and tints it. The wave factor drives the motion, so animating it animates the wave.

public class WaterWaveEffect : ShaderEffect

Inherits from / implements: ShaderEffect

Members at a glance

WaterWaveEffectInitializes a new instance of the WaterWaveEffect class.
ColorFilterThe color the waved image is tinted with.
InputThe image this effect is applied to. It is set for you when the effect is attached to an element; set it directly only when using the effect as a brush.
WaveFactorHow pronounced the wave is. Animate this property to make the wave roll.
ColorFilterPropertyIdentifies the ColorFilter dependency property.
InputPropertyIdentifies the Input dependency property.
WaveFactorPropertyIdentifies the WaveFactor dependency property.

Constructors

WaterWaveEffect

public WaterWaveEffect()

Initializes a new instance of the WaterWaveEffect class.

Properties

ColorFilter

public Color ColorFilter

The color the waved image is tinted with.

Input

public Brush Input

The image this effect is applied to. It is set for you when the effect is attached to an element; set it directly only when using the effect as a brush.

WaveFactor

public double WaveFactor

How pronounced the wave is. Animate this property to make the wave roll.

Fields

ColorFilterProperty

public static readonly DependencyProperty ColorFilterProperty

Identifies the ColorFilter dependency property.

InputProperty

public static readonly DependencyProperty InputProperty

Identifies the Input dependency property.

WaveFactorProperty

public static readonly DependencyProperty WaveFactorProperty

Identifies the WaveFactor dependency property.