RasterImageAnimator Constructor

Summary

Constructs a new RasterImageAnimator object using the specified parameters.

Syntax

C++

public RasterImageAnimator( 
   RasterImage targetImage, 
   RasterImage animatedImage 
)

Public Function New( _ 
   ByVal targetImage As RasterImage, _ 
   ByVal animatedImage As RasterImage _ 
)

public: 
RasterImageAnimator(  
   RasterImage^ targetImage, 
   RasterImage^ animatedImage 
)

Parameters

targetImage
A RasterImage object referencing the target image.

animatedImage
A RasterImage object containing the frames to be played. This object must be a multi-frame image (The value of RasterImage.AnimationGlobalLoop must be something other than -1. You can also pass a null reference (Nothing in VisualBasic) to let the method create an empty multi-frame image.

Remarks targetImage must be allocated before calling this method

If you pass null (Nothing in VisualBasic) in the animatedImage parameter, you can use the Append method to add frames to the multi-frame image during the animation. This is useful if you want to play an animated file as it is being loaded. If you need to reference the multi-frame image after the animation, you can call the Destroy method before you dispose this RasterImageAnimator object.

The RasterImageAnimator class also implements the IDisposable interface, it is recommended that you follow the standard .NET dispose pattern when using the RasterImageAnimator class. For more information, refer to IDisposable.

Example

For an example, refer to RasterImageAnimator.

Requirements

Target Platforms