ColorKeyFrameAnimation Class

Reference

Definition

Namespace:: Windows.UI.Composition

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.

Edit

A time-based animation that targets the Color property with one or more color key frames.

The ColorKeyFrameAnimation class is one of the supported types of KeyFrameAnimations that is used to animate the Color property off of the Brush property on a SpriteVisual. When working with ColorKeyFrameAnimation s, utilize Windows.UI.Color objects for the values of keyframes. Utilize the InterpolationColorSpace property to define which color space the system will interpolate through for the animation.

public ref class ColorKeyFrameAnimation sealed : KeyFrameAnimation

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ColorKeyFrameAnimation final : KeyFrameAnimation

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ColorKeyFrameAnimation : KeyFrameAnimation

Public NotInheritable Class ColorKeyFrameAnimation
Inherits KeyFrameAnimation

Inheritance: Object Platform::Object IInspectable CompositionObject CompositionAnimation KeyFrameAnimation ColorKeyFrameAnimation

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10586.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v2.0)

Examples

void ColorAnimation(SpriteVisual visual)
{
  // Create the ColorKeyFrameAnimation
  var colorAnimation = _compositor.CreateColorKeyFrameAnimation();

  // Create the KeyFrames using Windows.UI.Color objects
  colorAnimation.InsertKeyFrame(0.5f, Colors.Purple);
  colorAnimation.InsertKeyFrame(1.0f, Colors.Cyan);

  // Set the interpolation to go through the HSL space
  colorAnimation.InterpolationColorSpace = CompositionColorSpace.Hsl;
  colorAnimation.Duration = TimeSpan.FromSeconds(3);

  // Apply the cubic-bezier to a KeyFrame
  visual.Brush.StartAnimation("Color", colorAnimation);
}

Remarks

Use the CompostionObject.StartAnimation and CompostionObject.StopAnimation methods to start and stop the animation.

An animation is associated with an object's property by calling CompositionObject.StartAnimation and specifying the property name and the animation. See the remarks section of CompositionObject.StartAnimation for a list of animatable properties.

Properties

Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
DelayBehavior	The delay behavior of the key frame animation. (Inherited from KeyFrameAnimation)
DelayTime	Delay before the animation starts after CompositionObject.StartAnimation is called. (Inherited from KeyFrameAnimation)
Direction	The direction the animation is playing. The Direction property allows you to drive your animation from start to end or end to start or alternate between start and end or end to start if animation has an IterationCount greater than one. This gives an easy way for customizing animation definitions. (Inherited from KeyFrameAnimation)
Dispatcher	The dispatcher for the CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompostionObject. (Inherited from CompositionObject)
Duration	The duration of the animation. (Inherited from KeyFrameAnimation)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
InitialValueExpressions	Gets the initial values for the animation. (Inherited from CompositionAnimation)
InterpolationColorSpace	The color space the color interpolation should run through. The ColorKeyFrameAnimation.InterpolationColorSpace property enables a developer to choose what color space the system will interpolate through when animating between two colors. Developers can choose between the CompositionColorSpace enum values Rgb, Hsl, or Auto (system chosen).
IterationBehavior	The iteration behavior for the key frame animation. (Inherited from KeyFrameAnimation)
IterationCount	The number of times to repeat the key frame animation. (Inherited from KeyFrameAnimation)
KeyFrameCount	The number of key frames in the KeyFrameAnimation. (Inherited from KeyFrameAnimation)
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)
StopBehavior	Specifies how to set the property value when StopAnimation is called. (Inherited from KeyFrameAnimation)
Target	The target of the animation. (Inherited from CompositionAnimation)

Methods

ClearAllParameters()	Clears all of the parameters of the animation. (Inherited from CompositionAnimation)
ClearParameter(String)	Clears a parameter from the animation. (Inherited from CompositionAnimation)
Close()	Closes the CompositionObject and releases system resources. (Inherited from CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Connects and animation. (Inherited from CompositionObject)
DisconnectAnimation(String)	Disconnects an animation. (Inherited from CompositionObject)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject)
InsertExpressionKeyFrame(Single, String)	Inserts an expression key frame. (Inherited from KeyFrameAnimation)
InsertExpressionKeyFrame(Single, String, CompositionEasingFunction)	Inserts an expression keyframe. (Inherited from KeyFrameAnimation)
InsertKeyFrame(Single, Color)	Inserts a key frame.
InsertKeyFrame(Single, Color, CompositionEasingFunction)	Inserts a key frame with the specified easing function.
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from CompositionObject)
SetBooleanParameter(String, Boolean)	Sets a boolean value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetColorParameter(String, Color)	Sets a Color value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetExpressionReferenceParameter(String, IAnimationObject)	Sets an object that implements IAnimationObject as a reference parameter in an ExpressionAnimation. (Inherited from CompositionAnimation)
SetMatrix3x2Parameter(String, Matrix3x2)	Sets a Matrix3x2 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetMatrix4x4Parameter(String, Matrix4x4)	Sets a Matrix4x4 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetQuaternionParameter(String, Quaternion)	Sets a Quaternion value for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetReferenceParameter(String, CompositionObject)	Sets a reference to a Composition object for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetScalarParameter(String, Single)	Sets a Scalar value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetVector2Parameter(String, Vector2)	Sets a Vector2 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetVector3Parameter(String, Vector3)	Sets a Vector3 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
SetVector4Parameter(String, Vector4)	Sets a Vector4 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation)
StartAnimation(String, CompositionAnimation)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	Starts an animation group. The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object. (Inherited from CompositionObject)
StopAnimation(String)	Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Stops an animation group. (Inherited from CompositionObject)
TryGetAnimationController(String)	Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject)

Applies to