IUIAnimationTimer::SetFrameRateThreshold method

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

Syntax


HRESULT SetFrameRateThreshold(
  [in] UINT32 framesPerSecond
);

Parameters

framesPerSecond [in]

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

Minimum supported client

Windows 7, Windows Vista and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

None supported

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

See also

IUIAnimationTimer
IUIAnimationTimerEventHandler

 

 

Show: