←Select platform

OceanCommand Constructor(int,int,bool)

Summary

Initializes a new OceanCommand class object with explicit parameters.

Syntax

WinRT C#

C++

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

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

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.

Example

Run the OceanCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void OceanConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // 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"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.SpecialEffects 
      Leadtools.Examples.Support.SetLicense() 
 
Public Sub OceanConstructorExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")) 
 
   ' 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

Requirements

Target Platforms

Reference

OceanCommand Class

OceanCommand Members

Overload List

Help Version 19.0.2017.10.27

Leadtools.ImageProcessing.SpecialEffects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.SpecialEffects Namespace

Assemblies