IXRBackEase::SetAmplitude (Compact 2013)

3/28/2014

This method sets the amplitude of retraction associated with an IXRBackEase animation.

Syntax

virtual HRESULT STDMETHODCALLTYPE SetAmplitude(
    __in float Amplitude
) = 0;

Parameters

• Amplitude
  [in] Float value that specifies the amplitude of retraction associated with an IXRBackEase animation. This value must be greater than or equal to 0 (zero). The default value is 1.

Return Value

Returns an HRESULT that indicates success or returns an error code.

Remarks

IXRBackEase produces a winding-up effect when used at the beginning of an animation, and a winding-down effect when used at the end of an animation. For example, if you create an animation that expands the height of a rectangle from 50 pixels to 100 pixels and apply the IXRBackEase easing function to the beginning of the animation, the rectangle will initially shrink below 50 pixels before expanding to 100. How much the rectangle shrinks depends upon the amplitude of retraction. The greater the amplitude value, the farther the animated value retracts.

.NET Framework Equivalent

System.Windows.Media.Animation.BackEase.Amplitude

Requirements

See Also

Reference

IXRBackEase