L_GetPlaybackUpdateRect (original) (raw)

Summary

Gets the update rectangle in the target bitmap during an animation playback. The rectangle uses bitmap coordinates, and it is cumulative.

Syntax

#include "l_bitmap.h"

L_LTDIS_API L_INT L_GetPlaybackUpdateRect(hPlayback, prcUpdate, fClear)

Parameters

HPLAYBACK hPlayback

Handle that references the animation playback.

L_RECT * prcUpdate

Address of the RECT structure that this function will fill with the coordinates of the update rectangle

L_BOOL fClear

TRUE if you want to clear the rectangle; FALSE if you do not.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

You usually call this after the following states, which you can get with the L_GetPlaybackState function:

Constant	Meaning
PLAYSTATE_POSTCLEAR	[0x0001] Indicates that the target bitmap has been cleared.
PLAYSTATE_POSTRENDER	[0x0004] Indicates that an image has been rendered to the target bitmap.
PLAYSTATE_POSTDISPOSE	[0x0009] Indicates that the current image has been disposed of. The index is incremented after processing this state.

This function uses bitmap coordinates to specify the update rectangle. Therefore, you must account for the bitmap's view perspective. For more information, refer to Accounting for View Perspective.

Required DLLs and Libraries

LTDIS
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64, Linux.

Example

For an example, refer to L_ProcessPlayback.
For a complete sample code, refer to the CHILD.C module of the DEMO example.

LEADTOOLS Raster Imaging C API Help