Flags Property

Summary

Gets or sets the enumeration that contains all the flags that are needed by the VignetteCommand. It includes the values used to select the shape of the vignette object and the type of color filling.

Syntax

C++/CLI

Python

public VignetteCommandFlags Flags { get; set; }

public: 
property VignetteCommandFlags Flags { 
   VignetteCommandFlags get(); 
   void set (    VignetteCommandFlags ); 
}

Flags # get and set (VignetteCommand)

Property Value

Enumeration containing all flags that are needed by the VignetteCommand. It includes the values used to select the shape of the vignette object and the type of color filling.

Example

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:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

VignetteCommand Class

VignetteCommand Members

Download our FREE evaluation

Help Version 22.0.2023.3.31

Leadtools.ImageProcessing.SpecialEffects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.SpecialEffects Namespace

Assemblies