←Select platform

VignnetCommand Class

Summary

Draws a specified shape and feathers it to the image. This method is available in the Imaging Pro and above toolkits.

Syntax

WinRT C#

C++

public class VignnetCommand : Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand, Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

Public Class VignnetCommand  
   Inherits Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand 
   Implements Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

public sealed class VignnetCommand : Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.SpecialEffects.VignnetCommand()

public ref class VignnetCommand : public Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand, Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

Remarks

This method can be used to draw a circle, ellipse, rectangle or square to create a vignette shape and then a color is feathered to the image, filling either the inside or the outside of the vignette shape.
This method supports 12-bit and 16-bit grayscale and 48-bit and 64-bit color images. Support for 12-bit and 16-bit grayscale and 48-bit and 64-bit color images is available only in the Document/Medical toolkits.
This method does not support signed data images.
This command does not support 32-bit grayscale images.

Example

Run the VignnetCommand on an image.

WinRT C#

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.SpecialEffects 
 
<TestMethod()> _ 
Public Sub VignnetCommandExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")) 
 
   ' Prepare the command 
   Dim command As VignnetCommand = New VignnetCommand 
   command.Origin = New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2) 
   command.Fading = 50 
   command.FadingRate = 100 
   command.Width = 20 
   command.Height = 20 
   command.VignetteColor = New RasterColor(0, 0, 0) 
   command.Flags = VignnetCommandFlags.Ellipse Or VignnetCommandFlags.Fillin 
   command.Run(leadImage) 
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24) 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void VignnetCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")); 
 
   // Prepare the command 
   VignnetCommand command = new VignnetCommand(); 
   command.Origin = new LeadPoint((image.Width / 2), (image.Height / 2)); 
   command.Fading        = 50; 
   command.FadingRate    = 100; 
   command.Width         = 20; 
   command.Height        = 20; 
   command.VignetteColor = new RasterColor(0,0,0); 
   command.Flags         = VignnetCommandFlags.Ellipse |   VignnetCommandFlags.Fillin; 
 
   command.Run(image); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24); 
 
} 
 
static class LEAD_VARS 
{ 
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public async Task VignnetCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   string srcFileName = @"Assets\Image1.cmp"; 
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName); 
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile)); 
 
   // Prepare the command 
   VignnetCommand command = new VignnetCommand(); 
   command.Origin = LeadPointHelper.Create((image.Width / 2), (image.Height / 2)); 
   command.Fading        = 50; 
   command.FadingRate    = 100; 
   command.Width         = 20; 
   command.Height        = 20; 
   command.VignetteColor = RasterColorHelper.Create(0,0,0); 
   command.Flags         = VignnetCommandFlags.Ellipse |   VignnetCommandFlags.Fillin; 
 
   command.Run(image); 
 
   string destFileName = @"result.bmp"; 
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName); 
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24); 
}