OverlayMergedCommand Class

Summary description for OverlayMergedCommand.

Merge two images of the same PixelFormat together specifying various merge types.

Inheritance Hierarchy

SystemObject
Atalasoft.Imaging.ImageProcessingImageCommand
Atalasoft.Imaging.ImageProcessingOverlayMergedCommand

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

Syntax

Copy

[SerializableAttribute]
public class OverlayMergedCommand : ImageCommand, 
	ISerializable

<SerializableAttribute>
Public Class OverlayMergedCommand
	Inherits ImageCommand
	Implements ISerializable

The OverlayMergedCommand type exposes the following members.

Constructors

	Name	Description
	OverlayMergedCommand	Initializes a new instance of the OverlayMergedCommand class.
	OverlayMergedCommand(SerializationInfo, StreamingContext)	Initializes a new instance of %OverlayMergedCommand%.
	OverlayMergedCommand(AtalaImage, MergeOption)	Initializes a new instance of %OverlayMergedCommand% specifying the top image, and the merge option.
	OverlayMergedCommand(AtalaImage, Point, MergeOption)	Initializes a new instance of %OverlayMergedCommand% specifying the top image, position of the image, and the merge option.
	OverlayMergedCommand(AtalaImage, Point, MergeOption, Double)	Initializes a new instance of %OverlayMergedCommand% specifying the top image, position of the image, the merge option, and a factor used for some merge options.

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.)
	Factor	Gets or sets the value of factor
	InPlaceProcessing	Gets a value indicating whether the command returns a new image or modified the source image passed into the command. (Overrides ImageCommandInPlaceProcessing.)
	MergeOption	Gets or sets the value of mergeOption
	Position	Gets or sets the value of position
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	SupportedPixelFormats	Returns an array of PixelFormats supported by this command. (Overrides ImageCommandSupportedPixelFormats.)
	TopImage	Gets or sets the value of topImage

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. (Inherited from ImageCommand.)
	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	Populates a SerializationInfo with the data needed to serialize the target object.
	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	Performs the actual command. (Overrides ImageCommandPerformActualCommand(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. (Inherited from ImageCommand.)
	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 ImageCommandVerifyProperties(AtalaImage).)

Top

Remarks

This method requires a continuous tone image. If the source image is not continuous, it will throw the ArgumentException

Remarks

This functionality is especially useful when combining alpha channels with options other than the default "maximum" used in the OverlayCommand when overlaying two RGBA images.

This command processes the source image in-place, and ApplyToImage always returns null.

Examples

Overlay (C#)

Copy

// Load the images to work with.
AtalaImage bottomImage = new AtalaImage(@"D:\Test Images\1.jpg");
AtalaImage topImage = new AtalaImage(@"D:\Test Images\1save.jpg");

// Overlay the top image into the bottom image with 50% opacity.
OverlayMergedCommand cmd = new OverlayMergedCommand(topImage, Point.Empty, MergeOption.FastBlend, 0.5);
cmd.ApplyToImage(bottomImage);

OverlayVB (Visual Basic)

Copy

' Load the images to work with.
Dim bottomImage As AtalaImage =  New AtalaImage("D:\Test Images\1.jpg") 
Dim topImage As AtalaImage =  New AtalaImage("D:\Test Images\1save.jpg") 

' Overlay the top image into the bottom image with 50% opacity.
Dim cmd As OverlayMergedCommand =  New OverlayMergedCommand(topImage,PoInteger.Empty, MergeOption.FastBlend, 0.5) 
cmd.ApplyToImage(bottomImage)

Reference

Atalasoft.Imaging.ImageProcessing Namespace

OverlayCommand

OverlayMaskedCommand