AtalaImage Class

The AtalaImage object holds the raw image data, a Palette, and methods used to access this data.

Inheritance Hierarchy

SystemObject
SystemMarshalByRefObject
Atalasoft.ImagingAtalaImage

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

Syntax

Copy

[SerializableAttribute]
public class AtalaImage : MarshalByRefObject, IDisposable, 
	ICloneable, ISerializable

<SerializableAttribute>
Public Class AtalaImage
	Inherits MarshalByRefObject
	Implements IDisposable, ICloneable, ISerializable

The AtalaImage type exposes the following members.

Constructors

	Name	Description
	AtalaImage	Initializes a new instance of the AtalaImage class.
	AtalaImage(Stream)	Initialize a new instance of a AtalaImage class specifying a Stream.
	AtalaImage(String)	Initialize a new instance of a AtalaImage class specifying the file of the image to open.
	AtalaImage(Stream, ProgressEventHandler)	Initialize a new instance of a %AtalaImage% class specifying a Stream and a progress delegate.
	AtalaImage(SerializationInfo, StreamingContext)	Creates an instance of an AtalaImage, with serialization info.
	AtalaImage(String, ProgressEventHandler)	Initialize a new instance of a AtalaImage class specifying the file of the image to open.
	AtalaImage(Int32, Int32, PixelFormat)	Initialize a new instance of the AtalaImage class specifying the Width, Height, and PixelFormat.
	AtalaImage(Stream, Int32, ProgressEventHandler)	Initialize a new instance of an AtalaImage class specifying an image Stream and a page index to decode.
	AtalaImage(String, Int32, ProgressEventHandler)	Initialize a new instance of an AtalaImage class specifying an image file and a page index to decode.
	AtalaImage(Int32, Int32, PixelFormat, Byte)	Initializes a new instance of the AtalaImage class.
	AtalaImage(Int32, Int32, PixelFormat, Color)	Initialize a new instance of the AtalaImage class specifying the Width, Height, PixelFormat, and Color to initialize the image background to.
	AtalaImage(IntPtr, Int32, Int32, PixelFormat)	Initialize a new instance of the %AtalaImage% class specifying the image pointer, Width, Height, and PixelFormat. This method is obsolete. Please use the constructor that takes a PixelMemory object instead.
	AtalaImage(Stream, Int32, ImageDecoder, ProgressEventHandler)	Initialize a new instance of an AtalaImage class specifying a Stream, ImageDecoder to use for decoding the image, and a progress delegate.
	AtalaImage(PixelMemory, Int32, Int32, PixelFormat)	Initialize a new instance of the %AtalaImage% class specifying the PixelMemory, Width, Height, and PixelFormat.

Top

Properties

	Name	Description
	BitmapMirror	Obsolete. Gets the Bitmap mirror of this %AtalaImage%.
	ColorDepth	Returns the number of bits per pixel of this AtalaImage.
	ColorProfile	Gets or sets the ColorProfile associated with this AtalaImage.
	DitherErrorMax	Obsolete. Gets or sets the diffusion or dither error that's applied to an image when converting to from a continuous tone to colormapped format.
	Edition	Gets the type of license being used.
	Height	Gets the height of this AtalaImage in pixels.
	ImageData	Obsolete. Gets the memory address of this AtalaImage. This property is unsupported. Using it will cause a compilation error. Use PixelMemory instead.
	Palette	Returns the palette object of this AtalaImage.
	PixelFormat	Sets or returns the PixelFormat of this AtalaImage.
	PixelFormatChanger	Get or set the class used to convert image pixel formats.
	PixelMemory	Provides access to the memory that represents an image.
	Resolution	Get or set the Resolution of this AtalaImage object
	RowStride	Get the number of bytes in each row of this AtalaImage.
	Size	Gets the size of this AtalaImage in pixels.
	Width	Returns the width of this AtalaImage in pixels.

Top

Methods

	Name	Description
	Clone	Returns a deep copy of this AtalaImage.
	CombineChannels	Combines the channels.
	CopyToClipboard	Copies the image data onto the clipboard.
	CountColors	Count the number of unique colors in this AtalaImage.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Dispose	Call this method to destroy this AtalaImage data and free memory.
	Dispose(Boolean)	Releases unmanaged and - optionally - managed resources.
	Draw(Graphics, Rectangle)	Draws this AtalaImage onto a System.Drawing.Graphics object at a specified location and size.
	Draw(Graphics, Rectangle, Rectangle)	Draws a specified area of this AtalaImage onto a System.Drawing.Graphics object at the specified location and size.
	Draw(Graphics, Rectangle, Rectangle, Boolean)	Draws a specified area of this AtalaImage onto a System.Drawing.Graphics object at the specified location and size.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FillRectangle(Rectangle, Color)	Fills a specified rectangle in this image with a specified solid color.
	FillRectangle(Rectangle, Int32)	Fills a specified rectangle in this image with a specified index.
	Finalize	The Destructor that will automatically be called by the garbage collector (Overrides ObjectFinalize.)
	Flip	Flips the image in the specified direction.
	FromBitmap(Bitmap)	Returns an AtalaImage containing a copy of the Bitmap.
	FromBitmap(Bitmap, Boolean)	Converts a specified Bitmap into an AtalaImage by taking ownership of the Bitmap data, or returning a copy of the Bitmap data.
	FromBitmapData	Obsolete. Returns an %AtalaImage% that contains the same image pointer that's in the specified BitmapData object.
	FromByteArray(Byte)	Creates a new AtalaImage from a byte array containing an encoded image.
	FromByteArray(Byte, ProgressEventHandler)	Creates a new AtalaImage from a byte array containing an encoded image.
	FromDib	Returns an AtalaImage from a DIB (Device Independent Bitmap) pointer.
	FromHBitmap	Returns an AtalaImage from an hBitmap handle.
	FromURL(String, Boolean, ProgressEventHandler)	Returns an AtalaImage loaded from the url.
	FromURL(String, Int32, Boolean, ProgressEventHandler)	Returns an AtalaImage loaded from the url.
	GetBitmap	Obsolete. Returns a System.Drawing.Bitmap object copied from this %AtalaImage%.
	GetChangedPixelFormat(PixelFormat)	Returns a new AtalaImage object with a different PixelFormat from this AtalaImage.
	GetChangedPixelFormat(PixelFormat, ColorProfile)	Returns a new AtalaImage object with a different PixelFormat from this AtalaImage.
	GetChangedPixelFormat(PixelFormat, ColorProfile, Boolean)	Returns a new AtalaImage object with a different PixelFormat from this AtalaImage specifying a ColorProfile and if the ChangedPixelFormat event should fire.
	GetGraphics	Returns a System.Drawing.Graphics object allowing GDI+ operations to draw onto this AtalaImage.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData	Used to serialize this AtalaImage.
	GetPackedBuffer	Gets the packed buffer.
	GetPixelCmykColor	Get the color of a pixel in CMYK space
	GetPixelColor	Returns the System.Drawing.Color of the specified pixel in this AtalaImage.
	GetPixelFormatDepth	Obsolete. Returns the color depth in bits per pixels associated with a specified PixelFormat.
	GetPixelIndex	Gets the palette index of the specified pixel in this AtalaImage.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImageFromClipboard	Creates a new AtalaImage from data on the clipboard.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnChangePixelFormat	Raises the [E:ChangePixelFormat] event.
	PixelFormatHasAlpha	Obsolete. Returns true if the specified PixelFormat contains an alpha channel.
	PixelFormatIsColormapped	Obsolete. Returns true if the specified PixelFormat contains a palette.
	PixelFormatIsContinuous	Obsolete. Returns true if the PixelFormat passed in is a continuous-tone format.
	PixelFormatIsTwoBytePerComponent	Obsolete. This method can be used to determine if a PixelFormat is a "Two Byte Per Component" image format.
	Save(Stream, ImageEncoder, ProgressEventHandler)	Saves this AtalaImage to a Stream object specifying an ImageType.
	Save(String, ImageEncoder, ProgressEventHandler)	Saves this %AtalaImage% to a file specifying an ImageEncoder and progress callback.
	Save(String, ImageType, ProgressEventHandler)	Obsolete. Saves this AtalaImage to a file specifying an ImageType and a PixelFormat.
	SetPixelCmykColor	Set the color of a pixel in CMYK space
	SetPixelColor	Sets the color of the pixel.
	SetPixelIndex	Sets the index of the pixel.
	SplitChannels	Returns an array of grayscale AtalaImage objects representing each 8-bit or 16-bit channel in the source image.
	SplitChannels(ChannelFlags)	Returns an array of grayscale %AtalaImage% objects representing specified 8-bit or 16-bit channels in the source image.
	ToBitmap	Returns a Bitmap object from this AtalaImage data.
	ToByteArray(ImageEncoder)	Returns a byte array containing an encoded image.
	ToByteArray(ImageEncoder, ProgressEventHandler)	Returns a byte array containing an encoded image.
	ToDib	Returns a pointer to a DIB (Device Independent Bitmap) copied from this AtalaImage.
	ToDib(Stream)	Fills the given stream with a DIB (Device Independent Bitmap) copied from this AtalaImage.
	ToString	Returns a textual description of this AtalaImage object. (Overrides ObjectToString.)
	UnregisteredWatermark	Unregistereds the watermark.

Top

Events

	Name	Description
	ChangePixelFormat	Occurs when the image data changes PixelFormats.

Top

Remarks

Image data is stored in a 32-bit row aligned buffer. See ToDib and FromDib(IntPtr, Boolean) for methods that will export or import from a DIB (Device Independent Bitmap).

The AtalaImage is used throughout DotImage and is similar to the Bitmap object in .NET.

Examples

Create an AtalaImage from a file (C#)

Copy

AtalaImage image = new AtalaImage("image.png");

Create an AtalaImage from a file (Visual Basic)

Copy

Dim image As AtalaImage = New AtalaImage("image.png")

Reference

Atalasoft.Imaging Namespace