ClearCommand Class

Summary

Sets all bits to 0 in the specified image, making it a black image.

Syntax

Objective-C

C++

Java

public class ClearCommand : RasterCommand

Public Class ClearCommand  
   Inherits RasterCommand

@interface LTClearCommand : LTRasterCommand

public class ClearCommand extends RasterCommand

public ref class ClearCommand : public RasterCommand

Remarks

Sets all bits to 0, in the specified image. If the image has a palette, all pixels will be the color of the first palette entry.

For more information, refer to Introduction to Image Processing With LEADTOOLS.

Example

This example will clear an image before saving it back to disk.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using LeadtoolsExamples.Common; 
 
public void ClearCommandExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(ImagesPath.Path, "Image1.cmp"); 
   string destFileName = Path.Combine(ImagesPath.Path, "Image1_clear.bmp"); 
 
   // Load the source image from disk 
   RasterImage image = codecs.Load(srcFileName); 
 
   // Clear the image 
   ClearCommand cmd = new ClearCommand(); 
   cmd.Run(image); 
 
   // Save the image to disk 
   codecs.Save( 
      image, 
      destFileName, 
      RasterImageFormat.Bmp, 
      24); 
 
   // Clean up 
   image.Dispose(); 
   codecs.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
 
Public Sub ClearCommandExample() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp") 
   Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_clear.bmp") 
 
   ' Load the source image from disk 
   Dim image As RasterImage = codecs.Load(srcFileName) 
 
   ' Clear the image 
   Dim cmd As ClearCommand = New ClearCommand() 
   cmd.Run(image) 
 
   ' Save the image to disk 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24) 
 
   ' Clean up 
   image.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Examples; 
using Leadtools.ImageProcessing; 
using Leadtools.Windows.Media; 
 
public void ClearCommandExample(RasterImage image, Stream destStream) 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Clear the image 
   ClearCommand cmd = new ClearCommand(); 
   cmd.Run(image); 
 
   // Save the image to disk 
   codecs.Save( 
      image, 
      destStream, 
      RasterImageFormat.Bmp, 
      24); 
 
   // Clean up 
   image.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.Windows.Media 
 
Public Sub ClearCommandExample(ByVal image As RasterImage, ByVal destStream As Stream) 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   ' Clear the image 
   Dim cmd As ClearCommand = New ClearCommand() 
   cmd.Run(image) 
 
   ' Save the image to disk 
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 24) 
 
   ' Clean up 
   image.Dispose() 
End Sub

Requirements

Target Platforms

Reference

ClearCommand Members

Leadtools.ImageProcessing Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies