Leadtools.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
PaintImageRegionEffect(IntPtr,RasterImage,Rectangle,Rectangle,Rectangle,Rectangle,RasterPaintProperties,SpecialEffectsType,SpecialEffectsProgress) Method
See Also  Example
Leadtools.SpecialEffects Namespace > SpecialEffectsProcessor Class > PaintImageRegionEffect Method : PaintImageRegionEffect(IntPtr,RasterImage,Rectangle,Rectangle,Rectangle,Rectangle,RasterPaintProperties,SpecialEffectsType,SpecialEffectsProgress) Method



hdc
Handle to a device context
image
Pointer to an object hat reference the bitmap that has the region to paint.
src
Rectangle to be used as the display source rectangle that specifies the part of the image to use as the display source.
srcClip
Rectangle to be used as the display source clipping rectangle that specifies the portion of the display source to paint. Generally, this is used for updating the display when part of the source image has changed.
dest
Rectangle to be used as the display destination rectangle that determines how the source rectangle is scaled and how the image is positioned in the device context. The coordinates for the Rectangle object are relative to the device context. There is no default for this parameter. You must specify the Rectangle object.
destClip
Rectangle to be used as the display destination clipping rectangle that specifies the portion of the display rectangle to paint. Generally, this is used for updating changes in the display surface, such as when a user moves another window, uncovering a part of the image that had been covered up. The coordinates for the Rectangle object are relative to the device context. You can pass null to use the default, which matches the device context.
paintProperties
Options for the display.
effectType
Effect to apply when painting. For valid values, refer to SpecialEffectsType.
progressCallback
Callback method that will be called when the paint image effect is started to determine the status for the paint of the image effect.
Applies an effect when painting a bitmap region to a device context. This method works the same as PaintImageEffect, except that only the bitmap region is painted.

Syntax

Visual Basic (Declaration)  
Public Overloads Sub PaintImageRegionEffect( _
   ByVal hdc As IntPtr, _
   ByVal image As RasterImage, _
   ByVal src As Rectangle, _
   ByVal srcClip As Rectangle, _
   ByVal dest As Rectangle, _
   ByVal destClip As Rectangle, _
   ByVal paintProperties As RasterPaintProperties, _
   ByVal effectType As SpecialEffectsType, _
   ByVal progressCallback As SpecialEffectsProgress _
) 
Visual Basic (Usage) Copy Code
Dim instance As SpecialEffectsProcessor
Dim hdc As IntPtr
Dim image As RasterImage
Dim src As Rectangle
Dim srcClip As Rectangle
Dim dest As Rectangle
Dim destClip As Rectangle
Dim paintProperties As RasterPaintProperties
Dim effectType As SpecialEffectsType
Dim progressCallback As SpecialEffectsProgress
 
instance.PaintImageRegionEffect(hdc, image, src, srcClip, dest, destClip, paintProperties, effectType, progressCallback)
C#  
public void PaintImageRegionEffect( 
   IntPtr hdc,
   RasterImage image,
   Rectangle src,
   Rectangle srcClip,
   Rectangle dest,
   Rectangle destClip,
   RasterPaintProperties paintProperties,
   SpecialEffectsType effectType,
   SpecialEffectsProgress progressCallback
)
C++/CLI  
public:
void PaintImageRegionEffect( 
   IntPtr hdc,
   RasterImage image,
   Rectangle src,
   Rectangle srcClip,
   Rectangle dest,
   Rectangle destClip,
   RasterPaintProperties paintProperties,
   SpecialEffectsType effectType,
   SpecialEffectsProgress^ progressCallback
) 

Parameters

hdc
Handle to a device context
image
Pointer to an object hat reference the bitmap that has the region to paint.
src
Rectangle to be used as the display source rectangle that specifies the part of the image to use as the display source.
srcClip
Rectangle to be used as the display source clipping rectangle that specifies the portion of the display source to paint. Generally, this is used for updating the display when part of the source image has changed.
dest
Rectangle to be used as the display destination rectangle that determines how the source rectangle is scaled and how the image is positioned in the device context. The coordinates for the Rectangle object are relative to the device context. There is no default for this parameter. You must specify the Rectangle object.
destClip
Rectangle to be used as the display destination clipping rectangle that specifies the portion of the display rectangle to paint. Generally, this is used for updating changes in the display surface, such as when a user moves another window, uncovering a part of the image that had been covered up. The coordinates for the Rectangle object are relative to the device context. You can pass null to use the default, which matches the device context.
paintProperties
Options for the display.
effectType
Effect to apply when painting. For valid values, refer to SpecialEffectsType.
progressCallback
Callback method that will be called when the paint image effect is started to determine the status for the paint of the image effect.

Example

This example shows the minimum requirements for using PaintImageRegionEffect method to paint an image .

Visual Basic Copy Code
Public Sub PaintImageRegionEffect(ByVal g As Graphics, ByVal destRect As Rectangle)
    Dim processor As SpecialEffectsProcessor = New SpecialEffectsProcessor()
    Dim properties As RasterPaintProperties = New RasterPaintProperties()
    properties.RasterOperation = RasterPaintProperties.SourceCopy

    RasterCodecs.Startup()
    Dim codecs As RasterCodecs = New RasterCodecs()
    Dim rasterImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp")

    processor.PaintImageRegionEffect(g, rasterImage, Rectangle.Empty, Rectangle.Empty, destRect, Rectangle.Empty, properties, SpecialEffectsType.SpiralIn, AddressOf SpecialEffectsProgress)

    rasterImage.Dispose()
    RasterCodecs.Shutdown()
End Sub

      Private Shared Function SpecialEffectsProgress(ByVal percent As Integer) As Boolean
 Console.WriteLine("{0}%", percent)
 Return True
      End Function
C# Copy Code
public void PaintImageRegionEffect(Graphics g, Rectangle destRect) 

   SpecialEffectsProcessor processor = new SpecialEffectsProcessor(); 
   RasterPaintProperties properties = new RasterPaintProperties(); 
   properties.RasterOperation = RasterPaintProperties.SourceCopy; 
 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   RasterImage rasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"); 
 
   processor.PaintImageRegionEffect(g, rasterImage, 
                                    Rectangle.Empty, /* Default source rectangle */ 
                                    Rectangle.Empty, /* Default source clip area */ 
                                    destRect, /* Destination rectangle */ 
                                    Rectangle.Empty, /* Default destination clipping rectangle */ 
                                    properties, 
                                    SpecialEffectsType.SpiralIn, /* Spiral effect */ 
                                    SpecialEffectsProgress); 
 
   rasterImage.Dispose(); 
   RasterCodecs.Shutdown(); 

 
static bool SpecialEffectsProgress(int percent) 

   Console.WriteLine("{0}%", percent); 
   return true; 
}

Remarks

Multipass painting for the PushClass is disabled.

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