SetAlphaFromMaskCommand Class

Creates an alpha channel for an image using an 8-bit grayscale mask image to control transparency.

Inheritance Hierarchy

System.Object
Atalasoft.Imaging.ImageProcessing.ImageCommand
Atalasoft.Imaging.ImageProcessing.Channels.SetAlphaFromMaskCommand

Namespace: Atalasoft.Imaging.ImageProcessing.Channels
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
public class SetAlphaFromMaskCommand : ImageCommand, 
	ISerializable

<SerializableAttribute>
Public Class SetAlphaFromMaskCommand
	Inherits ImageCommand
	Implements ISerializable

The SetAlphaFromMaskCommand type exposes the following members.

Constructors

	Name	Description
	SetAlphaFromMaskCommand()	Creates a new instance of SetAlphaFromMaskCommand.
	SetAlphaFromMaskCommand(SerializationInfo, StreamingContext)	Creates a new instance of SetAlphaFromMaskCommand from serialization information.
	SetAlphaFromMaskCommand(AtalaImage, Boolean, AlphaMergeType)	Creates a new instance of SetAlphaFromMask specifying maskImage, resizeMask and mergeType.
	SetAlphaFromMaskCommand(AtalaImage, Boolean, AlphaMergeType, Point)	Creates a new instance of SetAlphaFromMask specifying maskImage, resizeMask, mergeType and position.

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	InPlaceProcessing	Gets a value indicating if the source image data is processed in-place as opposed to returning a new image. (Inherited from ImageCommand.)
	MaskImage	Gets or sets an 8-bit image used to generate the alpha channel.
	MergeType	Gets or sets the type of merge performed.
	Position	Gets or sets the left, top position of the mask image.
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	ResizeMask	Gets or sets a valid to indicate if the mask should be resized to fit the image.
	SupportedPixelFormats	Returns an array of PixelFormats supported by this command. (Overrides ImageCommand.SupportedPixelFormats.)

Top

Methods

	Name	Description
	Apply	Apply the command to the given image. (Inherited from ImageCommand.)
	ApplyToImage	Obsolete. Applies the command to the source AtalaImage. (Inherited from ImageCommand.)
	ConstructChangedSourceImage	The method is called by the default implementation of Apply. It determines if it is necessary to create a copy of the source image in a different pixel format and if so, determines the best new pixel format and allocates that image. (Inherited from ImageCommand.)
	ConstructFinalImage	Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command. (Overrides ImageCommand.ConstructFinalImage(AtalaImage).)
	ConstructImageResults	Constructs the results object for this command. (Inherited from ImageCommand.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetChangedPixelFormat	This method is called to change the pixel format of the source image. (Inherited from ImageCommand.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Fills a SerializationInfo object with information about this command.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImageCommandGetObjectData	Aggregates ImageCommand data into the supplied SerializationInfo object. (Inherited from ImageCommand.)
	IsPixelFormatSupported	Returns a value indicating if the specified pixel format is supported. (Inherited from ImageCommand.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformActualCommand	PerformActualCommand does the actual work of the image processing command. (Overrides ImageCommand.PerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
	SelectBestAlternatePixelFormat	Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable. (Inherited from ImageCommand.)
	SelectPreferredPixelFormat	Chooses a pixel format that is preferred for this command. (Overrides ImageCommand.SelectPreferredPixelFormat(AtalaImage, PixelFormat,PixelFormat[]).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyImage	Verify the integrity of an AtalaImage. (Inherited from ImageCommand.)
	VerifyProperties	Verifies the properties. (Overrides ImageCommand.VerifyProperties(AtalaImage).)

Top

Remarks

This command will result in a 16-bit grayscale-alpha or 32-bit RGBA image.

Examples

SetAlphaFromMask (C#)

Copy

// Load a 24-bit image.
AtalaImage image = new AtalaImage(@"D:\Test Images\1.jpg");

// Load the 8-bit grayscale mask.
AtalaImage mask = new AtalaImage(@"D:\Test Images\JPG\8-bit alpha mask.jpg");

// Apply the mask to the image and create the new 32-bit image.
SetAlphaFromMaskCommand cmd = new SetAlphaFromMaskCommand(mask, true, AlphaMergeType.UseMostTransparent);
AtalaImage result = cmd.Apply(image).Image;

// Free the image and mask.
image.Dispose();
mask.Dispose();

SetAlphaFromMask (Visual Basic)

Copy

' Load a 24-bit image.
Dim image As AtalaImage = New AtalaImage("D:\Test Images\1.jpg") 

' Load the 8-bit grayscale mask.
Dim mask As AtalaImage = New AtalaImage("D:\Test Images\JPG\8-bit alpha mask.jpg") 

' Apply the mask to the image and create the new 32-bit image.
Dim cmd As SetAlphaFromMaskCommand = New SetAlphaFromMaskCommand(mask, True, AlphaMergeType.UseMostTransparent) 
Dim result As AtalaImage = cmd.Apply(image).Image 

' Free the image and mask.
image.Dispose()
mask.Dispose()

Reference

Atalasoft.Imaging.ImageProcessing.Channels Namespace