LEADTOOLS Raster Imaging C++ Class Library Help > Classes and Member Functions > LPlayBack > LPlayBack Member Functions > LPlayBack::GetUpdateRect |
#include "ltwrappr.h"
virtual L_INT LPlayBack::GetUpdateRect(prcUpdate, bClear)
LPRECT prcUpdate; |
/* address of a RECT structure */ |
L_BOOL bClear; |
/* flag that indicates whether to clear the rectangle */ |
Gets the updated rectangle of the target bitmap during an animation playback. The rectangle uses bitmap coordinates, and it is cumulative.
Parameter |
Description |
|
prcUpdate |
Address of the RECT structure to be updated with the coordinates of the updated rectangle |
|
bClear |
Flag that indicates whether to clear the rectangle. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
Clear the rectangle. |
|
FALSE |
Do not clear the rectangle. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
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 |
[0x0003] Indicates that an image has been rendered to the target bitmap. |
PLAYSTATE_POSTDISPOSE |
[0x0005] 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. |
Win32, x64.
See Also
Functions: |
|
Topics: |
Raster Image Functions: Creating and Maintaining Lists of Images |
|
Example
For an example, refer to LPlayBack::Append.