Edit

Share via

CompositorExtensions.CreateScalarKeyFrameAnimation Method

Definition

Namespace:
Microsoft.Toolkit.Uwp.UI.Animations
Assembly:
Microsoft.Toolkit.Uwp.UI.Animations.dll
Package:
Microsoft.Toolkit.Uwp.UI.Animations v7.0.2
Package:
Microsoft.Toolkit.Uwp.UI.Animations v7.1.2
Source:
CompositorExtensions.cs
Source:
CompositorExtensions.cs

Creates a Windows.UI.Composition.ScalarKeyFrameAnimation instance with the given parameters to on a target element.

public static Windows.UI.Composition.ScalarKeyFrameAnimation CreateScalarKeyFrameAnimation(this Windows.UI.Composition.Compositor compositor, string? target, float to, float? from = default, TimeSpan? delay = default, TimeSpan? duration = default, Windows.UI.Composition.CompositionEasingFunction? easing = default, Windows.UI.Composition.AnimationDelayBehavior delayBehavior = Windows.UI.Composition.AnimationDelayBehavior.SetInitialValueBeforeDelay, Windows.UI.Composition.AnimationDirection direction = Windows.UI.Composition.AnimationDirection.Normal, Windows.UI.Composition.AnimationIterationBehavior iterationBehavior = Windows.UI.Composition.AnimationIterationBehavior.Count, int iterationCount = 1);
static member CreateScalarKeyFrameAnimation : Windows.UI.Composition.Compositor * string * single * Nullable<single> * Nullable<TimeSpan> * Nullable<TimeSpan> * Windows.UI.Composition.CompositionEasingFunction * Windows.UI.Composition.AnimationDelayBehavior * Windows.UI.Composition.AnimationDirection * Windows.UI.Composition.AnimationIterationBehavior * int -> Windows.UI.Composition.ScalarKeyFrameAnimation
<Extension()>
Public Function CreateScalarKeyFrameAnimation (compositor As Compositor, target As String, to As Single, Optional from As Nullable(Of Single) = Nothing, Optional delay As Nullable(Of TimeSpan) = Nothing, Optional duration As Nullable(Of TimeSpan) = Nothing, Optional easing As CompositionEasingFunction = Nothing, Optional delayBehavior As AnimationDelayBehavior = Windows.UI.Composition.AnimationDelayBehavior.SetInitialValueBeforeDelay, Optional direction As AnimationDirection = Windows.UI.Composition.AnimationDirection.Normal, Optional iterationBehavior As AnimationIterationBehavior = Windows.UI.Composition.AnimationIterationBehavior.Count, Optional iterationCount As Integer = 1) As ScalarKeyFrameAnimation

Parameters

compositor
Windows.UI.Composition.Compositor

The current Windows.UI.Composition.Compositor instance used to create the animation.

target
String

The optional target property to animate.

to
Single

The final value for the animation.

from
Nullable<Single>

The optional starting value for the animation.

delay
Nullable<TimeSpan>

The optional initial delay for the animation.

duration
Nullable<TimeSpan>

The optional animation duration.

easing
Windows.UI.Composition.CompositionEasingFunction

The optional easing function for the animation.

delayBehavior
Windows.UI.Composition.AnimationDelayBehavior

The delay behavior to use for the animation.

direction
Windows.UI.Composition.AnimationDirection

The direction to use when playing the animation.

iterationBehavior
Windows.UI.Composition.AnimationIterationBehavior

The iteration behavior to use for the animation.

iterationCount
Int32

The iteration count to use for the animation.

Returns

Windows.UI.Composition.ScalarKeyFrameAnimation

A Windows.UI.Composition.ScalarKeyFrameAnimation instance with the specified parameters.

Applies to