GetUpdateRectangle Method

Summary

Gets the update rectangle in the target image during an animation playback.

Syntax

C++

public LeadRect GetUpdateRectangle( 
   bool clear 
)

Public Function GetUpdateRectangle( _ 
   ByVal clear As Boolean _ 
) As LeadRect

public: 
LeadRect GetUpdateRectangle(  
   bool clear 
)

Parameters

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

Return Value

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

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:

Value	Meaning
RasterImageAnimatorState.PostClear	Indicates that the target image has been cleared
RasterImageAnimatorState.PostRender	that a frame has been rendered to the target image
RasterImageAnimatorState.PostDispose	Indicates 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.

Example

For an example, refer to RasterImageAnimator.

Requirements

Target Platforms