VignetteCommand Class

Summary

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

Syntax

C++

public class VignetteCommand : RasterCommand

  
Public Class VignetteCommand  
   Inherits RasterCommand

public ref class VignetteCommand : public RasterCommand

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 VignetteCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void VignetteCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")); 
 
   // Prepare the command 
   VignetteCommand command = new VignetteCommand(); 
   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 = VignetteCommandFlags.Ellipse | VignetteCommandFlags.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:\LEADTOOLS21\Resources\Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.SpecialEffects 
 
Public Sub VignetteCommandExample() 
   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 VignetteCommand = New VignetteCommand 
   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 = VignetteCommandFlags.Ellipse Or VignetteCommandFlags.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:\LEADTOOLS21\Resources\Images" 
End Class

Requirements

Target Platforms

Reference

VignetteCommand Members

Leadtools.ImageProcessing.SpecialEffects Namespace

Leadtools.ImageProcessing.Effects.CombineCommand

Leadtools.ImageProcessing.Effects.FeatherAlphaBlendCommand

Leadtools.ImageProcessing.Effects.TextureAlphaBlendCommand

Download our FREE evaluation

Help Version 21.0.2021.6.30