ClearCommand Class

Summary

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

Syntax

Objective-C

C++/CLI

Java

Python

public class ClearCommand : RasterCommand

@interface LTClearCommand : LTRasterCommand

public class ClearCommand extends RasterCommand

public ref class ClearCommand : public RasterCommand

class ClearCommand(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; 
 
 
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"; 
}