AnimationExtensions.Saturation Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
Saturation(AnimationSet, Double, Double, Double, EasingType, EasingMode) |
Saturates the visual within the animation set. |
Saturation(FrameworkElement, Double, Double, Double, EasingType, EasingMode) |
Saturates the FrameworkElement. |
Saturation(AnimationSet, Double, Double, Double, EasingType, EasingMode)
Saturates the visual within the animation set.
public static Microsoft.Toolkit.Uwp.UI.Animations.AnimationSet Saturation (this Microsoft.Toolkit.Uwp.UI.Animations.AnimationSet animationSet, double value = 0, double duration = 500, double delay = 0, Microsoft.Toolkit.Uwp.UI.Animations.EasingType easingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Windows.UI.Xaml.Media.Animation.EasingMode easingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseOut);
static member Saturation : Microsoft.Toolkit.Uwp.UI.Animations.AnimationSet * double * double * double * Microsoft.Toolkit.Uwp.UI.Animations.EasingType * Windows.UI.Xaml.Media.Animation.EasingMode -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationSet
<Extension()>
Public Function Saturation (animationSet As AnimationSet, Optional value As Double = 0, Optional duration As Double = 500, Optional delay As Double = 0, Optional easingType As EasingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Optional easingMode As EasingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseOut) As AnimationSet
Parameters
- animationSet
- AnimationSet
The animation set.
- value
- Double
The value. 0 is desaturated, 1 is saturated.
- duration
- Double
The duration in milliseconds.
- delay
- Double
The delay in milliseconds.
- easingType
- EasingType
The EasingType
- easingMode
- Windows.UI.Xaml.Media.Animation.EasingMode
The Windows.UI.Xaml.Media.Animation.EasingMode
Returns
An animation set with saturation effects incorporated.
Applies to
Saturation(FrameworkElement, Double, Double, Double, EasingType, EasingMode)
Saturates the FrameworkElement.
public static Microsoft.Toolkit.Uwp.UI.Animations.AnimationSet Saturation (this Windows.UI.Xaml.FrameworkElement associatedObject, double value = 0, double duration = 500, double delay = 0, Microsoft.Toolkit.Uwp.UI.Animations.EasingType easingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Windows.UI.Xaml.Media.Animation.EasingMode easingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseOut);
static member Saturation : Windows.UI.Xaml.FrameworkElement * double * double * double * Microsoft.Toolkit.Uwp.UI.Animations.EasingType * Windows.UI.Xaml.Media.Animation.EasingMode -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationSet
<Extension()>
Public Function Saturation (associatedObject As FrameworkElement, Optional value As Double = 0, Optional duration As Double = 500, Optional delay As Double = 0, Optional easingType As EasingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Optional easingMode As EasingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseOut) As AnimationSet
Parameters
- associatedObject
- Windows.UI.Xaml.FrameworkElement
The associated object.
- value
- Double
The value, between 0 and 1. 0 is desaturated, 1 is saturated.
- duration
- Double
The duration in milliseconds.
- delay
- Double
The delay in milliseconds.
- easingType
- EasingType
The EasingType
- easingMode
- Windows.UI.Xaml.Media.Animation.EasingMode
The Windows.UI.Xaml.Media.Animation.EasingMode
Returns
An animation set with saturation effects incorporated.