Click or drag to resize

AtalaImage Class

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

Namespace:  Atalasoft.Imaging
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class AtalaImage : MarshalByRefObject, IDisposable, 
	ICloneable, ISerializable

The AtalaImage type exposes the following members.

Constructors
  NameDescription
Public methodAtalaImage
Initializes a new instance of the AtalaImage class.
Public methodAtalaImage(Stream)
Initialize a new instance of a AtalaImage class specifying a Stream.
Public methodAtalaImage(String)
Initialize a new instance of a AtalaImage class specifying the file of the image to open.
Public methodAtalaImage(Stream, ProgressEventHandler)
Initialize a new instance of a %AtalaImage% class specifying a Stream and a progress delegate.
Protected methodAtalaImage(SerializationInfo, StreamingContext)
Creates an instance of an AtalaImage, with serialization info.
Public methodAtalaImage(String, ProgressEventHandler)
Initialize a new instance of a AtalaImage class specifying the file of the image to open.
Public methodAtalaImage(Int32, Int32, PixelFormat)
Initialize a new instance of the AtalaImage class specifying the Width, Height, and PixelFormat.
Public methodAtalaImage(Stream, Int32, ProgressEventHandler)
Initialize a new instance of an AtalaImage class specifying an image Stream and a page index to decode.
Public methodAtalaImage(String, Int32, ProgressEventHandler)
Initialize a new instance of an AtalaImage class specifying an image file and a page index to decode.
Public methodAtalaImage(Int32, Int32, PixelFormat, Byte)
Initializes a new instance of the AtalaImage class.
Public methodAtalaImage(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.
Public methodAtalaImage(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.

Public methodAtalaImage(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.
Public methodAtalaImage(PixelMemory, Int32, Int32, PixelFormat)
Initialize a new instance of the %AtalaImage% class specifying the PixelMemory, Width, Height, and PixelFormat.
Top
Properties
  NameDescription
Public propertyBitmapMirror Obsolete.
Gets the Bitmap mirror of this %AtalaImage%.
Public propertyColorDepth
Returns the number of bits per pixel of this AtalaImage.
Public propertyColorProfile
Gets or sets the ColorProfile associated with this AtalaImage.
Public propertyStatic memberDitherErrorMax 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.
Public propertyStatic memberEdition
Gets the type of license being used.
Public propertyHeight
Gets the height of this AtalaImage in pixels.
Public propertyCode exampleImageData Obsolete.
Gets the memory address of this AtalaImage. This property is unsupported. Using it will cause a compilation error. Use PixelMemory instead.
Public propertyPalette
Returns the palette object of this AtalaImage.
Public propertyPixelFormat
Sets or returns the PixelFormat of this AtalaImage.
Public propertyStatic memberPixelFormatChanger
Get or set the class used to convert image pixel formats.
Public propertyPixelMemory
Provides access to the memory that represents an image.
Public propertyResolution
Get or set the Resolution of this AtalaImage object
Public propertyRowStride
Get the number of bytes in each row of this AtalaImage.
Public propertySize
Gets the size of this AtalaImage in pixels.
Public propertyWidth
Returns the width of this AtalaImage in pixels.
Top
Methods
  NameDescription
Public methodClone
Returns a deep copy of this AtalaImage.
Public methodStatic memberCombineChannels
Combines the channels.
Public methodCopyToClipboard
Copies the image data onto the clipboard.
Public methodCountColors
Count the number of unique colors in this AtalaImage.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Call this method to destroy this AtalaImage data and free memory.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Public methodDraw(Graphics, Rectangle)
Draws this AtalaImage onto a System.Drawing.Graphics object at a specified location and size.
Public methodDraw(Graphics, Rectangle, Rectangle)
Draws a specified area of this AtalaImage onto a System.Drawing.Graphics object at the specified location and size.
Public methodDraw(Graphics, Rectangle, Rectangle, Boolean)
Draws a specified area of this AtalaImage onto a System.Drawing.Graphics object at the specified location and size.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFillRectangle(Rectangle, Color)
Fills a specified rectangle in this image with a specified solid color.
Public methodFillRectangle(Rectangle, Int32)
Fills a specified rectangle in this image with a specified index.
Protected methodFinalize
The Destructor that will automatically be called by the garbage collector
(Overrides ObjectFinalize.)
Public methodFlip
Flips the image in the specified direction.
Public methodStatic memberFromBitmap(Bitmap)
Returns an AtalaImage containing a copy of the Bitmap.
Public methodStatic memberFromBitmap(Bitmap, Boolean)
Converts a specified Bitmap into an AtalaImage by taking ownership of the Bitmap data, or returning a copy of the Bitmap data.
Public methodStatic memberCode exampleFromBitmapData Obsolete.
Returns an %AtalaImage% that contains the same image pointer that's in the specified BitmapData object.
Public methodStatic memberFromByteArray(Byte)
Creates a new AtalaImage from a byte array containing an encoded image.
Public methodStatic memberFromByteArray(Byte, ProgressEventHandler)
Creates a new AtalaImage from a byte array containing an encoded image.
Public methodStatic memberFromDib
Returns an AtalaImage from a DIB (Device Independent Bitmap) pointer.
Public methodStatic memberFromHBitmap
Returns an AtalaImage from an hBitmap handle.
Public methodStatic memberFromURL(String, Boolean, ProgressEventHandler)
Returns an AtalaImage loaded from the url.
Public methodStatic memberFromURL(String, Int32, Boolean, ProgressEventHandler)
Returns an AtalaImage loaded from the url.
Public methodGetBitmap Obsolete.
Returns a System.Drawing.Bitmap object copied from this %AtalaImage%.
Public methodGetChangedPixelFormat(PixelFormat)
Returns a new AtalaImage object with a different PixelFormat from this AtalaImage.
Public methodCode exampleGetChangedPixelFormat(PixelFormat, ColorProfile)
Returns a new AtalaImage object with a different PixelFormat from this AtalaImage.
Public methodGetChangedPixelFormat(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.
Public methodGetGraphics
Returns a System.Drawing.Graphics object allowing GDI+ operations to draw onto this AtalaImage.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetObjectData
Used to serialize this AtalaImage.
Public methodStatic memberGetPackedBuffer
Gets the packed buffer.
Public methodGetPixelCmykColor
Get the color of a pixel in CMYK space
Public methodGetPixelColor
Returns the System.Drawing.Color of the specified pixel in this AtalaImage.
Public methodStatic memberCode exampleGetPixelFormatDepth Obsolete.
Returns the color depth in bits per pixels associated with a specified PixelFormat.
Public methodGetPixelIndex
Gets the palette index of the specified pixel in this AtalaImage.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberImageFromClipboard
Creates a new AtalaImage from data on the clipboard.
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodOnChangePixelFormat
Raises the [E:ChangePixelFormat] event.
Public methodStatic memberCode examplePixelFormatHasAlpha Obsolete.
Returns true if the specified PixelFormat contains an alpha channel.
Public methodStatic memberPixelFormatIsColormapped Obsolete.
Returns true if the specified PixelFormat contains a palette.
Public methodStatic memberPixelFormatIsContinuous Obsolete.

Returns true if the PixelFormat passed in is a continuous-tone format.

Public methodStatic memberPixelFormatIsTwoBytePerComponent Obsolete.
This method can be used to determine if a PixelFormat is a "Two Byte Per Component" image format.
Public methodCode exampleSave(Stream, ImageEncoder, ProgressEventHandler)
Saves this AtalaImage to a Stream object specifying an ImageType.
Public methodSave(String, ImageEncoder, ProgressEventHandler)
Saves this %AtalaImage% to a file specifying an ImageEncoder and progress callback.
Public methodCode exampleSave(String, ImageType, ProgressEventHandler) Obsolete.
Saves this AtalaImage to a file specifying an ImageType and a PixelFormat.
Public methodSetPixelCmykColor
Set the color of a pixel in CMYK space
Public methodSetPixelColor
Sets the color of the pixel.
Public methodSetPixelIndex
Sets the index of the pixel.
Public methodSplitChannels
Returns an array of grayscale AtalaImage objects representing each 8-bit or 16-bit channel in the source image.
Public methodSplitChannels(ChannelFlags)
Returns an array of grayscale %AtalaImage% objects representing specified 8-bit or 16-bit channels in the source image.
Public methodToBitmap
Returns a Bitmap object from this AtalaImage data.
Public methodToByteArray(ImageEncoder)
Returns a byte array containing an encoded image.
Public methodToByteArray(ImageEncoder, ProgressEventHandler)
Returns a byte array containing an encoded image.
Public methodToDib
Returns a pointer to a DIB (Device Independent Bitmap) copied from this AtalaImage.
Public methodToDib(Stream)
Fills the given stream with a DIB (Device Independent Bitmap) copied from this AtalaImage.
Public methodToString

Returns a textual description of this AtalaImage object.

(Overrides ObjectToString.)
Public methodStatic memberUnregisteredWatermark
Unregistereds the watermark.
Top
Events
  NameDescription
Public eventStatic memberCode exampleChangePixelFormat
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#)
AtalaImage image = new AtalaImage("image.png");
Create an AtalaImage from a file (Visual Basic)
Dim image As AtalaImage = New AtalaImage("image.png")
See Also