Error processing SSI file
LEADTOOLS Image Processing (Leadtools.ImageProcessing.SpecialEffects assembly)
Show in webframe

OceanCommand Constructor(Int32,Int32,Boolean)








Leadtools.ImageProcessing.SpecialEffects Namespace > OceanCommand Class > OceanCommand Constructor : OceanCommand Constructor(Int32,Int32,Boolean)
Wave magnitude, in pixels. This parameter only accepts positive values.
Number of repeated waves. This parameter only accepts positive values.
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.
Initializes a new OceanCommand class object with explicit parameters.
Syntax
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.
        

    


            

            
            
            
            
        
            
Example
Run the OceanCommand on an image.

             
    

            
            

            Copy Code
                
            

            

    

     

            
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.SpecialEffects

<TestMethod()> _
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

            

   

     

            
using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.SpecialEffects;

[TestMethod]
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";
}

            

   

     

            
using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.SpecialEffects;

[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);
}

            

   

      
	
      
	
    

            
            
Requirements
Target Platforms

            
            
See Also
Reference
OceanCommand Class

OceanCommand Members

Overload List




        
    

	
    

	Error processing SSI file