Click or drag to resize

SetAlphaFromMaskCommand Class

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

Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessing.ChannelsSetAlphaFromMaskCommand

Namespace:  Atalasoft.Imaging.ImageProcessing.Channels
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class SetAlphaFromMaskCommand : ImageCommand, 
	ISerializable

The SetAlphaFromMaskCommand type exposes the following members.

Constructors
  NameDescription
Public methodSetAlphaFromMaskCommand
Creates a new instance of SetAlphaFromMaskCommand.
Protected methodSetAlphaFromMaskCommand(SerializationInfo, StreamingContext)
Creates a new instance of SetAlphaFromMaskCommand from serialization information.
Public methodSetAlphaFromMaskCommand(AtalaImage, Boolean, AlphaMergeType)
Creates a new instance of SetAlphaFromMask specifying maskImage, resizeMask and mergeType.
Public methodSetAlphaFromMaskCommand(AtalaImage, Boolean, AlphaMergeType, Point)
Creates a new instance of SetAlphaFromMask specifying maskImage, resizeMask, mergeType and position.
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
(Inherited from ImageCommand.)
Public propertyMaskImage
Gets or sets an 8-bit image used to generate the alpha channel.
Public propertyMergeType
Gets or sets the type of merge performed.
Public propertyPosition
Gets or sets the left, top position of the mask image.
Public propertyProgress
Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process.
(Inherited from ImageCommand.)
Public propertyResizeMask
Gets or sets a valid to indicate if the mask should be resized to fit the image.
Public propertySupportedPixelFormats
Returns an array of PixelFormats supported by this command.
(Overrides ImageCommandSupportedPixelFormats.)
Top
Methods
  NameDescription
Public methodApply
Apply the command to the given image.
(Inherited from ImageCommand.)
Public methodApplyToImage Obsolete.
Applies the command to the source AtalaImage.
(Inherited from ImageCommand.)
Protected methodConstructChangedSourceImage
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.)
Protected methodConstructFinalImage
Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command.
(Overrides ImageCommandConstructFinalImage(AtalaImage).)
Protected methodConstructImageResults
Constructs the results object for this command.
(Inherited from ImageCommand.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetChangedPixelFormat
This method is called to change the pixel format of the source image.
(Inherited from ImageCommand.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Fills a SerializationInfo object with information about this command.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodImageCommandGetObjectData
Aggregates ImageCommand data into the supplied SerializationInfo object.
(Inherited from ImageCommand.)
Public methodIsPixelFormatSupported
Returns a value indicating if the specified pixel format is supported.
(Inherited from ImageCommand.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformActualCommand
PerformActualCommand does the actual work of the image processing command.
(Overrides ImageCommandPerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
Protected methodSelectBestAlternatePixelFormat
Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable.
(Inherited from ImageCommand.)
Protected methodSelectPreferredPixelFormat
Chooses a pixel format that is preferred for this command.
(Overrides ImageCommandSelectPreferredPixelFormat(AtalaImage, PixelFormat, PixelFormat).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodVerifyImage
Verify the integrity of an AtalaImage.
(Inherited from ImageCommand.)
Protected methodVerifyProperties
Verifies the properties.
(Overrides ImageCommandVerifyProperties(AtalaImage).)
Top
Remarks
This command will result in a 16-bit grayscale-alpha or 32-bit RGBA image.
Examples
SetAlphaFromMask (C#)
// 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)
' 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()
See Also