IUIAnimationTimer::SetFrameRateThreshold method (uianimation.h)

Sets the frame rate below which the timer notifies the application that rendering is too slow.

Syntax

HRESULT SetFrameRateThreshold(
  [in] UINT32 framesPerSecond
);

Parameters

[in] framesPerSecond

The minimum desirable frame rate, in frames per second.

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

If the rendering frame rate for an animation falls below the specified frame rate, an IUIAnimationTimerEventHandler::OnRenderingTooSlow event is raised.

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

See also

IUIAnimationTimer

IUIAnimationTimerEventHandler