IUIAnimationInterpolator::SetDuration method (uianimation.h)

Article
02/22/2024

Sets the duration of the transition.

Syntax

HRESULT SetDuration(
  [in] UI_ANIMATION_SECONDS duration
);

Parameters

[in] duration

The duration of the transition.

Return value

If the 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 calls this method only after calling the GetDependencies method, and only if that call returns UI_ANIMATION_DEPENDENCY_DURATION as one of its durationDependencies flags.

Typically, an interpolator with a duration dependency will have a duration parameter in its associated creation method of IUIAnimationTransitionFactory. The interpolator should store its duration when first initialized and overwrite it when SetDuration is called.

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

Windows Animation can call SetInitialValueAndVelocity and SetDuration 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 SetDuration reflect the updated state.

Requirements

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