Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetUpdateRectangle Method
See Also 
Leadtools Namespace > RasterImageAnimator Class : GetUpdateRectangle Method



clear
true if you want to clear the rectangle; false if you do not.
Gets the update rectangle in the target image during an animation playback.

Syntax

Visual Basic (Declaration) 
Public Function GetUpdateRectangle( _
   ByVal clear As Boolean _
) As Rectangle
Visual Basic (Usage)Copy Code
Dim instance As RasterImageAnimator
Dim clear As Boolean
Dim value As Rectangle
 
value = instance.GetUpdateRectangle(clear)
C# 
public Rectangle GetUpdateRectangle( 
   bool clear
)
C++/CLI 
public:
Rectangle GetUpdateRectangle( 
   bool clear
) 

Parameters

clear
true if you want to clear the rectangle; false if you do not.

Return Value

A Rectangle that this method will fill with the coordinates of the update rectangle.

Example

For an example, refer to RasterImageAnimator.

Remarks

The rectangle uses image coordinates, and it is cumulative.

You usually call this after the following states, which you can get with the State property:
ValueMeaning
RasterImageAnimatorState.PostClearIndicates that the target image has been cleared
RasterImageAnimatorState.PostRenderthat a frame has been rendered to the target image
RasterImageAnimatorState.PostDisposeIndicates that the current frame has been disposed of. The index is incremented after processing this state

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

.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also