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



opacity
A percentage value that indicates the amount of blending between the plasma color patterns and the original image. Possible values range from 0 to 100. Use 0 when not using an image, and 100 when not using the plasma values.
size
Value greater than 0 that represents the plasma size. (The value is divided internally by 100). The value, after it has been divided by 100, represents the size in pixels.
shift
The amount of color shift in the plasma color pattern. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. A value of 0 means there is no color shift.
redFrequency
Value that indicates which frequencies of red color should be used to create plasma patterns. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. Use 0 to turn off processing for the red frequencies.
greenFrequency
Value that indicates which frequencies of green color should be used to create plasma patterns. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. Use 0 to turn off processing for the green frequencies.
blueFrequency
Value that indicates which frequencies of blue color should be used to create plasma patterns. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. Use 0 to turn off processing for the blue frequencies.
flags
Enumeration that indicates which type of plasma effect to create, and which color pattern to use.
Initializes a new PlasmaCommand with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal opacity As Integer, _
   ByVal size As Integer, _
   ByVal shift As Integer, _
   ByVal redFrequency As Integer, _
   ByVal greenFrequency As Integer, _
   ByVal blueFrequency As Integer, _
   ByVal flags As PlasmaCommandFlags _
)
Visual Basic (Usage)Copy Code
Dim opacity As Integer
Dim size As Integer
Dim shift As Integer
Dim redFrequency As Integer
Dim greenFrequency As Integer
Dim blueFrequency As Integer
Dim flags As PlasmaCommandFlags
 
Dim instance As New PlasmaCommand(opacity, size, shift, redFrequency, greenFrequency, blueFrequency, flags)
C# 
public PlasmaCommand( 
   int opacity,
   int size,
   int shift,
   int redFrequency,
   int greenFrequency,
   int blueFrequency,
   PlasmaCommandFlags flags
)
C++/CLI 
public:
PlasmaCommand( 
   int opacity,
   int size,
   int shift,
   int redFrequency,
   int greenFrequency,
   int blueFrequency,
   PlasmaCommandFlags flags
)

Parameters

opacity
A percentage value that indicates the amount of blending between the plasma color patterns and the original image. Possible values range from 0 to 100. Use 0 when not using an image, and 100 when not using the plasma values.
size
Value greater than 0 that represents the plasma size. (The value is divided internally by 100). The value, after it has been divided by 100, represents the size in pixels.
shift
The amount of color shift in the plasma color pattern. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. A value of 0 means there is no color shift.
redFrequency
Value that indicates which frequencies of red color should be used to create plasma patterns. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. Use 0 to turn off processing for the red frequencies.
greenFrequency
Value that indicates which frequencies of green color should be used to create plasma patterns. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. Use 0 to turn off processing for the green frequencies.
blueFrequency
Value that indicates which frequencies of blue color should be used to create plasma patterns. Valid range for the 16, 48, and 64-bit images is from 0 to 65535 and for 12-bit images from 0 to 4095. Otherwise, it is from 0 to 255. Use 0 to turn off processing for the blue frequencies.
flags
Enumeration that indicates which type of plasma effect to create, and which color pattern to use.

Example

Run the Leadtools.ImageProcessing.SpecialEffects.PlasmaCommand on an image.

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

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

   ' Prepare the command
   ' Draw crossed plasma colors of size 15 over the current image, use CustomColor flag
   ' to be able to define color frequencies for color pattern, shift color pattern 50 steps,
   ' and blend the effect into the current image with opacity of 70%
   Dim command As PlasmaCommand = New PlasmaCommand(70, 1000, 50, 2000, 0, 6000, PlasmaCommandFlags.Cross Or PlasmaCommandFlags.CustomColor)
   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 PlasmaConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      // Draw crossed plasma colors of size 15 over the current image, use CustomColor flag
      // to be able to define color frequencies for color pattern, shift color pattern 50 steps, 
      // and blend the effect into the current image with opacity of 70%
      PlasmaCommand command = new PlasmaCommand(80, 1000, 50, 2000, 0, 6000, PlasmaCommandFlags.Cross | PlasmaCommandFlags.CustomColor);
      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