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


#include "ltwrappr.h"

virtual L_INT LPlayBack::GetUpdateRect(prcUpdate, bClear)


LPRECT prcUpdate

Address of the RECT structure to be updated with the coordinates of the updated rectangle

L_BOOL bClear

Flag that indicates whether to clear the rectangle. Possible values are:

Value Meaning
TRUE Clear the rectangle.
FALSE Do not clear the rectangle.


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


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

Value 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


Win32, x64.

See Also




For an example, refer to LPlayBack::Append.

Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help