LEADTOOLS Image Processing (Leadtools.ImageProcessing.SpecialEffects assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
FunctionalLightCommand Constructor(Int32,LeadPoint,FunctionalLightCommandFlags)
See Also  Example
Leadtools.ImageProcessing.SpecialEffects Namespace > FunctionalLightCommand Class > FunctionalLightCommand Constructor : FunctionalLightCommand Constructor(Int32,LeadPoint,FunctionalLightCommandFlags)



redAmplitude
If the image is grayscale, this parameter represents the amplitude of the master channel. If the image is color and the FunctionalLightCommandFlags.Multiply or FunctionalLightCommandFlags.LinearQuadratic flags are set, this parameter represents the amplitude of each channel. If the image is color and the FunctionalLightCommandFlags.Addition flag is used, this represents the amplitude of the red channel. This value is an integer with a value greater than or equal to 0. This value will be multiplied with the results of the selected function (sine, cosine, user buffer , _). The results of the multiplications are then added to the pixel values. These functions as well as the real buffer values are from -1 to 1. Possible values for the redAmplitude parameter are from 0-100.
origin
Represents the coordinates of the origin, in pixels. This parameter is used if the FunctionalLightCommandFlags.Trigonometry flag and the FunctionalLightCommandFlags.Circles flags are set, or if the FunctionalLightCommandFlags.LinearQuadratic flag is set.
flags
Flags that indicate the to use. For a list of available flags, FunctionalLightCommandFlags
Initializes a new FunctionalLightCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal redAmplitude As Integer, _
   ByVal origin As LeadPoint, _
   ByVal flags As FunctionalLightCommandFlags _
)
Visual Basic (Usage)Copy Code
Dim redAmplitude As Integer
Dim origin As LeadPoint
Dim flags As FunctionalLightCommandFlags
 
Dim instance As New FunctionalLightCommand(redAmplitude, origin, flags)
C# 
public FunctionalLightCommand( 
   int redAmplitude,
   LeadPoint origin,
   FunctionalLightCommandFlags flags
)
C++/CLI 
public:
FunctionalLightCommand( 
   int redAmplitude,
   LeadPoint origin,
   FunctionalLightCommandFlags flags
)

Parameters

redAmplitude
If the image is grayscale, this parameter represents the amplitude of the master channel. If the image is color and the FunctionalLightCommandFlags.Multiply or FunctionalLightCommandFlags.LinearQuadratic flags are set, this parameter represents the amplitude of each channel. If the image is color and the FunctionalLightCommandFlags.Addition flag is used, this represents the amplitude of the red channel. This value is an integer with a value greater than or equal to 0. This value will be multiplied with the results of the selected function (sine, cosine, user buffer , _). The results of the multiplications are then added to the pixel values. These functions as well as the real buffer values are from -1 to 1. Possible values for the redAmplitude parameter are from 0-100.
origin
Represents the coordinates of the origin, in pixels. This parameter is used if the FunctionalLightCommandFlags.Trigonometry flag and the FunctionalLightCommandFlags.Circles flags are set, or if the FunctionalLightCommandFlags.LinearQuadratic flag is set.
flags
Flags that indicate the to use. For a list of available flags, FunctionalLightCommandFlags

Example

Run the FunctionalLightCommand on an image.

Visual BasicCopy Code
Public Sub FunctionalLightConstructorExample_S1()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   ' Prepare the command
   Dim command As FunctionalLightCommand = New FunctionalLightCommand(75, New LeadPoint(CType((leadImage.Width / 2), Integer), CType((leadImage.Height / 2), Integer)), FunctionalLightCommandFlags.LinearQuadratic Or FunctionalLightCommandFlags.LinearInner)
   ' Apply the linear lighting effect.
   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
C#Copy Code
public void FunctionalLightConstructorExample_S1()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));

      // Prepare the command
      FunctionalLightCommand command = new FunctionalLightCommand(75, new LeadPoint(image.Width / 2, image.Height / 2), FunctionalLightCommandFlags.LinearQuadratic | FunctionalLightCommandFlags.LinearOuter);
      // Apply the linear lighting effect.
      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";
}

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also