Leadtools.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.8.31
DrawEffect Method
See Also  Example
Leadtools.SpecialEffects Namespace > SpecialEffectsProcessor Class : DrawEffect Method




Performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device context into a destination device context, while applying a special effect.

Overload List

Overload Description
DrawEffect(Graphics,Point,Graphics,Rectangle,SpecialEffectsType,Int32,Int32,Int32,Int32,Int32,Int32,Boolean,Color,Int32,Color,Int32,SpecialEffectsProgress) Performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device context into a destination device context, while applying a special effect.  
DrawEffect(IntPtr,Point,IntPtr,Rectangle,SpecialEffectsType,Int32,Int32,Int32,Int32,Int32,Int32,Boolean,Color,Int32,Color,Int32,SpecialEffectsProgress) Performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device context into a destination device context, while applying a special effect.  

Example

This example shows how to use DrawEffect with wave effect .

Visual Basic Copy Code
Public Sub DrawEffect(ByVal g As Graphics, ByVal destRect As Rectangle)
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()
   Dim rasterImage As RasterImage = codecs.Load("C:\Program Files\LEAD Technologies, Inc\LEADTOOLS 15\Images\Image1.cmp")
   Dim image As Image = rasterImage.ConvertToGdiPlusImage()
   Dim srcGraphics As Graphics = Graphics.FromImage(image)

   Dim processor As SpecialEffectsProcessor = New SpecialEffectsProcessor()

   processor.DrawEffect(srcGraphics, New Point(0, 0), g, destRect, SpecialEffectsType.WaveTB, 1, 10, 20, 1, 3, 3, False, Color.Black, 3, Color.Red, RasterPaintProperties.SourceCopy, Nothing)

   srcGraphics.Dispose()
   image.Dispose()
   rasterImage.Dispose()

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void DrawEffect(Graphics g, Rectangle destRect) 

   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   RasterImage rasterImage = codecs.Load(@"C:\Program Files\LEAD Technologies, Inc\LEADTOOLS 15\Images\Image1.cmp"); 
   Image image = rasterImage.ConvertToGdiPlusImage(); 
   Graphics srcGraphics = Graphics.FromImage(image); 
 
   SpecialEffectsProcessor processor = new SpecialEffectsProcessor(); 
 
   processor.DrawEffect(srcGraphics, 
                        new Point(0, 0), 
                        g, 
                        destRect, 
                        SpecialEffectsType.WaveTB, 
                        1,                /* graining size */ 
                        10,               /* delay between graining steps */ 
                        20,               /* speed of the wave */ 
                        1,                /* number of cycles or repetitions */ 
                        3,                /* step number for the pattern brush */ 
                        3,                /* maximum steps for the pattern brush */ 
                        false,            /* do not use transparency */ 
                        Color.Black,      /* transparent color, black */ 
                        3,                /* wand width */ 
                        Color.Red,        /* wand color, red */ 
                        RasterPaintProperties.SourceCopy, 
                        null); 
 
   srcGraphics.Dispose(); 
   image.Dispose(); 
   rasterImage.Dispose(); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

Use this method as a replacement for the Windows BitBlt API method when you want a special painting effect.

Use the grain and delay parameters to control the speed of the display. The grain parameter controls the size of the painting increment, and delay controls the time between increments.

The wand is a solid color bar that moves during an effect. Small grain sizes produce the best wand effects. Many of the effects listed in SpecialEffectsType can have a wand.

Use the pass and maxPass parameters to paint the image in more than one pass. For example, if you want a 3-pass paint, use maxPass of 3 and paint 3 times, once with pass = 1, once with pass = 2, and once with pass = 3.

Multipass painting for the PushClass is disabled.

If the effectType parameter is from the Twirl class, White Turnover class, Turnover class, Replace class, Laser class, Fade Normal class, Fade Black and White class, Fade Color class or Wave Class, the pass and maxPass parameters have no effect.

If the effectType parameter is from the Fade Normal class, Fade Black and White class or Fade Color class, the grain parameter has no effect. However, if the effectType parameter is from the Wave class, the grain parameter contains the wave size.

If the effectType parameter is from the White Turnover class, the Turnover class or the Replace class, the wandWidth and wandColor parameters have no effect. However, if the effectType parameter is from the Fade Color class, the wandColor parameter contains the bitmap color level.

The speed and cycles parameters have effect only if the effectType parameter is from the Wave class.

For general information, refer to Implementing Special Effects .

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also