SetAlphaValueCommand Class

This command will create an alpha channel based on a numeric value.

Inheritance Hierarchy

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

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 SetAlphaValueCommand : ImageCommand, 
	ISerializable, IThreadableCommand, ICloneable

<SerializableAttribute>
Public Class SetAlphaValueCommand
	Inherits ImageCommand
	Implements ISerializable, IThreadableCommand, ICloneable

The SetAlphaValueCommand type exposes the following members.

Constructors

	Name	Description
	SetAlphaValueCommand()	Creates a new instance of SetAlphaValueCommand.
	SetAlphaValueCommand(Byte, AlphaMergeType)	Creates a new instance of SetAlphaValueCommand specifying the alpha value and merge type.
	SetAlphaValueCommand(SerializationInfo, StreamingContext)	Creates a new instance of SetAlphaValueCommand from serialization information.

Top

Properties

	Name	Description
	AlphaValue	Gets or sets a value of 0 to 255 indicating the opacity to use on the alpha channel.
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	AutoThread	If set to true the IThreadableCommand will automatically parallelize image processing.
	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.)
	MergeType	Gets or sets the type of merge performed.
	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 ImageCommand.SupportedPixelFormats.)

Top

Methods

	Name	Description
	AdjustBands	Sets the image area which will be processed and also defines the bands or chunks of the image of which each will be sent to a separate thread.
	Apply	Apply the command to the given image. (Overrides ImageCommand.Apply(AtalaImage).)
	ApplyToImage	Obsolete. Applies the command to the source AtalaImage. (Inherited from ImageCommand.)
	Clone	Returns a copy of the command.
	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.)
	InternalActualCommand	InternalActualCommand does the actual work of the image processing command.
	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).)
	PerformSectionCommand	Performs the command on a specified section of the image.
	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	Verify the integrity of properties in the command before processing an image. (Overrides ImageCommand.VerifyProperties(AtalaImage).)

Top

Remarks

This method will convert 1-bit, 4-bit and 8-bit grayscale images to 8-bit indexed. 24-bit images will be converted to 32-bit.

This method requires a 8-bit Indexed, 16-bit or 32-bit image. All other images will throw an exception.

Reference

Atalasoft.Imaging.ImageProcessing.Channels Namespace