←Select platform

ClearCommand Class

Summary
Sets all bits to 0 in the specified image, making it a black image.
Syntax
C#
VB
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.

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
 
 
public void ClearCommandExample() 
{ 
	RasterCodecs codecs = new RasterCodecs(); 
 
	string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
	string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "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(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
} 
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:\LEADTOOLS22\Resources\Images" 
End Class 
Requirements

Target Platforms

Help Version 22.0.2021.11.10
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.