OceanCommand Constructor(Int32,Int32,Boolean)

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public OceanCommand( 
   int amplitude,
   int frequency,
   bool lowerTransparency
)

'Declaration
 
Public Function New( _
   ByVal amplitude As Integer, _
   ByVal frequency As Integer, _
   ByVal lowerTransparency As Boolean _
)

'Usage
 
Dim amplitude As Integer
Dim frequency As Integer
Dim lowerTransparency As Boolean
 
Dim instance As New OceanCommand(amplitude, frequency, lowerTransparency)

public OceanCommand( 
   int amplitude,
   int frequency,
   bool lowerTransparency
)

function OceanCommand( 
   amplitude ,
   frequency ,
   lowerTransparency 
)

public:
OceanCommand( 
   int amplitude,
   int frequency,
   bool lowerTransparency
)

Parameters

amplitude

Wave magnitude, in pixels. This parameter only accepts positive values.

frequency

Number of repeated waves. This parameter only accepts positive values.

lowerTransparency

Flag that indicates the transparency direction. Possible values are:

Value	Meaning
TRUE	Transparency increases as you move from the bottom of the image to the top of the image, line by line.
FALSE	Transparency increases as you move from the top of the image to the bottom of the image, line by line.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub OceanConstructorExample()
   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 OceanCommand = New OceanCommand(20, 6, True)
   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

public void OceanConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      OceanCommand command = new OceanCommand(20, 6, true);
      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";
}

[TestMethod]
public async Task OceanConstructorExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepare the command
   OceanCommand command = new OceanCommand(20, 6, true);
   command.Run(image);

   string destFileName = @"result.bmp";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

OceanCommand Class
OceanCommand Members
Overload List