VignetteCommand Constructor(LeadPoint,int,int,int,int,RasterColor,VignetteCommandFlags)

Summary

Initializes a new VignetteCommand with explicit parameters.

Syntax

C++/CLI

Python

public VignetteCommand( 
   LeadPoint origin, 
   int fading, 
   int fadingRate, 
   int width, 
   int height, 
   RasterColor vignetteColor, 
   VignetteCommandFlags flags 
)

public: 
VignetteCommand(  
   LeadPoint origin, 
   int fading, 
   int fadingRate, 
   int width, 
   int height, 
   RasterColor vignetteColor, 
   VignetteCommandFlags flags 
)

__init__(self,origin,fading,fadingRate,width,height,vignetteColor,flags) # Overloaded constructor

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.

height
Represents the value that indicates the height in pixels of the vignette ellipse or rectangle objects.This property is ignored if the VignetteCommandFlags.Circle or VignetteCommandFlags.Square flag is set.

vignetteColor
Represents the value that specifies the vignette object color.

flags
Enumeration that specifies how to apply the Vignette effect.

Example

Run the VignetteCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
 
public void VignetteConstructorExample() 
{ 
   // 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(new LeadPoint((image.Width / 2), (image.Height / 2)), 50, 100, 20, 20, new RasterColor(0, 0, 0), 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:\LEADTOOLS23\Resources\Images"; 
}

Requirements

Target Platforms

Reference

VignetteCommand Class

VignetteCommand Members

Overload List

Download our FREE evaluation

Help Version 23.0.2024.2.29