IUIAnimationInterpolator2::InterpolateVelocity method (uianimation.h)

Article
02/22/2024

Interpolates the velocity, or rate of change, at the specified offset for the given dimension.

Syntax

HRESULT InterpolateVelocity(
  [in]  UI_ANIMATION_SECONDS offset,
  [out] DOUBLE               *velocity,
  [in]  UINT                 cDimension
);

Parameters

[in] offset

The offset from the start of the transition.

The offset is always greater than or equal to zero and less than or equal to the duration of the transition. This method is not called if the duration of the transition is zero.

[out] velocity

The interpolated velocity.

[in] cDimension

The dimension in which to interpolate the velocity.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See Windows Animation Error Codes for a list of error codes.

Remarks

Windows Animation always calls the IUIAnimationInterpolator2::SetInitialValueAndVelocity method to set the initial value and velocity before calling InterpolateVelocity, so a custom interpolator need not check whether the initial value and velocity have been set.

Windows Animation can call SetInitialValueAndVelocity multiple times with different parameters. Interpolators can cache internal state to improve performance, but they must update this cached state each time SetInitialValueAndVelocity is called and ensure that the results of subsequent calls to InterpolateVelocity reflect the updated state.

Requirements

Requirement	Value
Minimum supported client	Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Minimum supported server	None supported
Target Platform	Windows
Header	uianimation.h
DLL	UIAnimation.dll