Leadtools.ImageProcessing.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
VignnetCommand Constructor(Point,Int32,Int32,Int32,RasterColor,VignnetCommandFlags)
See Also  Example
Leadtools.ImageProcessing.SpecialEffects Namespace > VignnetCommand Class > VignnetCommand Constructor : VignnetCommand Constructor(Point,Int32,Int32,Int32,RasterColor,VignnetCommandFlags)



origin
Center point for all vignette objects (circle, ellipse, rectangle, and square).
fading
Represents the percent of feathering in towards or outward from the vignette object. Negative values mean that the feathering will start outside the boundaries of the object and increase toward the object. Positive values mean that the feathering will start on the boundaries of the object and increase away from the object. Possible values range from -100 to 100.
fadingRate
Represents the value that indicates the fading rate. This value is used to controlling the fading process. It will be divided by 100 internally. The valid range is from 0 to 100.
width
Represents the value that indicates the dimension of the vignette object in pixels.
vignetteColor
Represents the value that specifies the vignette object color.
flags
Enumeration that specifies how to apply the Vignnet effect.
Initializes a new VignnetCommand with explicit parameters.

Syntax

Visual Basic (Declaration)  
Public Function New( _
   ByVal origin As Point, _
   ByVal fading As Integer, _
   ByVal fadingRate As Integer, _
   ByVal width As Integer, _
   ByVal vignetteColor As RasterColor, _
   ByVal flags As VignnetCommandFlags _
)
Visual Basic (Usage) Copy Code
Dim origin As Point
Dim fading As Integer
Dim fadingRate As Integer
Dim width As Integer
Dim vignetteColor As RasterColor
Dim flags As VignnetCommandFlags
 
Dim instance As VignnetCommand(origin, fading, fadingRate, width, vignetteColor, flags)
C#  
public VignnetCommand( 
   Point origin,
   int fading,
   int fadingRate,
   int width,
   RasterColor vignetteColor,
   VignnetCommandFlags flags
)
C++/CLI  
public:
VignnetCommand( 
   Point origin,
   int fading,
   int fadingRate,
   int width,
   RasterColor vignetteColor,
   VignnetCommandFlags flags
)

Parameters

origin
Center point for all vignette objects (circle, ellipse, rectangle, and square).
fading
Represents the percent of feathering in towards or outward from the vignette object. Negative values mean that the feathering will start outside the boundaries of the object and increase toward the object. Positive values mean that the feathering will start on the boundaries of the object and increase away from the object. Possible values range from -100 to 100.
fadingRate
Represents the value that indicates the fading rate. This value is used to controlling the fading process. It will be divided by 100 internally. The valid range is from 0 to 100.
width
Represents the value that indicates the dimension of the vignette object in pixels.
vignetteColor
Represents the value that specifies the vignette object color.
flags
Enumeration that specifies how to apply the Vignnet effect.

Example

Run the VignnetCommand on an image.

Visual Basic Copy Code
Public Sub VignnetConstructorExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim command As VignnetCommand = New VignnetCommand(New Point(leadImage.Width \ 2, leadImage.Height \ 2), 50, 100, 20, 20, New RasterColor(0, 0, 0), VignnetCommandFlags.Ellipse Or VignnetCommandFlags.Fillin)
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void VignnetConstructorExample() 

   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   VignnetCommand command = new VignnetCommand(new Point((image.Width/2),(image.Height/2)), 50, 100, 20, 20, new RasterColor(0,0,0), VignnetCommandFlags.Ellipse | VignnetCommandFlags.Fillin); 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

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