FreeImageAPI.FreeImageBitmap Class Reference

Encapsulates a FreeImage-bitmap. More...

Inheritance diagram for FreeImageAPI.FreeImageBitmap:

Public Member Functions
	FreeImageBitmap (FreeImageBitmap original)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image. More...
	FreeImageBitmap (FreeImageBitmap original, Size newSize)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (FreeImageBitmap original, int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Image original)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image. More...
	FreeImageBitmap (Image original, Size newSize)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Image original, int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Bitmap original)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image. More...
	FreeImageBitmap (Bitmap original, Size newSize)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Bitmap original, int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Stream stream, bool useIcm)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream. More...
	FreeImageBitmap (Stream stream)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream. More...
	FreeImageBitmap (Stream stream, FREE_IMAGE_FORMAT format)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format. More...
	FreeImageBitmap (Stream stream, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream with the specified loading flags. More...
	FreeImageBitmap (Stream stream, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format with the specified loading flags. More...
	FreeImageBitmap (string filename)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file. More...
	FreeImageBitmap (string filename, bool useIcm)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file. More...
	FreeImageBitmap (string filename, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file with the specified loading flags. More...
	FreeImageBitmap (string filename, FREE_IMAGE_FORMAT format)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format. More...
	FreeImageBitmap (string filename, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format with the specified loading flags. More...
	FreeImageBitmap (int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size. More...
	FreeImageBitmap (Type type, string resource)
	Initializes a new instance of the FreeImageBitmap class bases on the specified resource. More...
	FreeImageBitmap (int width, int height, Graphics g)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size and with the resolution of the specified System.Drawing.Graphics object. More...
	FreeImageBitmap (int width, int height, PixelFormat format)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size and format. More...
	FreeImageBitmap (int width, int height, FREE_IMAGE_TYPE type)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size and type. Only non standard bitmaps are supported. More...
	FreeImageBitmap (int width, int height, int stride, PixelFormat format, IntPtr scan0)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (int width, int height, int stride, PixelFormat format, byte[] bits)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (int width, int height, int stride, int bpp, FREE_IMAGE_TYPE type, IntPtr scan0)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (int width, int height, int stride, int bpp, FREE_IMAGE_TYPE type, byte[] bits)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (SerializationInfo info, StreamingContext context)
	Initializes a new instance of the FreeImageBitmap class. More...
RectangleF	GetBounds (ref GraphicsUnit pageUnit)
	Gets the bounds of this FreeImageBitmap in the specified unit. More...
PropertyItem	GetPropertyItem (int propid)
	Gets the specified property item from this FreeImageBitmap. More...
FreeImageBitmap	GetThumbnailImage (int thumbWidth, int thumbHeight, Image.GetThumbnailImageAbort callback, IntPtr callBackData)
	Returns a thumbnail for this FreeImageBitmap. More...
FreeImageBitmap	GetThumbnailImage (int maxPixelSize, bool convert)
	Returns a thumbnail for this FreeImageBitmap, keeping aspect ratio. maxPixelSize defines the maximum width or height of the thumbnail. More...
Bitmap	ToBitmap ()
	Converts this FreeImageBitmap instance to a Bitmap instance. More...
Scanline< T >	GetScanline< T > (int scanline)
	Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image. More...
object	GetScanline (int scanline)
	Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image. More...
IntPtr	GetScanlinePointer (int scanline)
	Returns a pointer to the specified scanline. Due to FreeImage bitmaps are bottum up, scanline 0 is the most bottom line of the image. More...
IList	GetScanlines ()
	Returns a list of structures, representing the scanlines of this FreeImageBitmap. Due to FreeImage bitmaps are bottum up, scanline 0 is the bottom-most line of the image. Each color depth has a different representing structure due to different memory layouts. More...
void	RemovePropertyItem (int propid)
	Removes the specified property item from this FreeImageBitmap. More...
void	RotateFlip (RotateFlipType rotateFlipType)
	This method rotates, flips, or rotates and flips this FreeImageBitmap. More...
void	CloneMetadataFrom (FreeImageBitmap bitmap)
	Copies the metadata from another FreeImageBitmap. More...
void	CloneMetadataFrom (FreeImageBitmap bitmap, FREE_IMAGE_METADATA_COPY flags)
	Copies the metadata from another FreeImageBitmap using the provided options. More...
void	Save (string filename)
	Saves this FreeImageBitmap to the specified file. More...
void	Save (string filename, FREE_IMAGE_FORMAT format)
	Saves this FreeImageBitmap to the specified file in the specified format. More...
void	Save (string filename, FREE_IMAGE_FORMAT format, FREE_IMAGE_SAVE_FLAGS flags)
	Saves this FreeImageBitmap to the specified file in the specified format using the specified saving flags. More...
void	Save (Stream stream, FREE_IMAGE_FORMAT format)
	Saves this FreeImageBitmap to the specified stream in the specified format. More...
void	Save (Stream stream, FREE_IMAGE_FORMAT format, FREE_IMAGE_SAVE_FLAGS flags)
	Saves this FreeImageBitmap to the specified stream in the specified format using the specified saving flags. More...
void	SaveAdd ()
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (int insertPosition)
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (FreeImageBitmap bitmap)
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (FreeImageBitmap bitmap, int insertPosition)
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (string filename)
	Adds a frame to the file specified. More...
void	SaveAdd (string filename, int insertPosition)
	Adds a frame to the file specified. More...
void	SaveAdd (string filename, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a frame to the file specified using the specified parameters. More...
void	SaveAdd (string filename, int insertPosition, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a frame to the file specified using the specified parameters. More...
void	SelectActiveFrame (int frameIndex)
	Selects the frame specified by the index. More...
IntPtr	GetHbitmap ()
	Creates a GDI bitmap object from this FreeImageBitmap. More...
IntPtr	GetHbitmap (Color background)
	Creates a GDI bitmap object from this FreeImageBitmap. More...
IntPtr	GetHicon ()
	Returns the handle to an icon. More...
IntPtr	GetHbitmapForDevice ()
	Creates a GDI bitmap object from this FreeImageBitmap with the same color depth as the primary device. More...
unsafe Color	GetPixel (int x, int y)
	Gets the Color of the specified pixel in this FreeImageBitmap. More...
void	MakeTransparent ()
	Makes the default transparent color transparent for this FreeImageBitmap. More...
void	MakeTransparent (Color transparentColor)
	Makes the specified color transparent for this FreeImageBitmap. More...
unsafe void	SetPixel (int x, int y, Color color)
	Sets the System.Drawing.Color of the specified pixel in this FreeImageBitmap. More...
void	SetResolution (float xDpi, float yDpi)
	Sets the resolution for this FreeImageBitmap. More...
BitmapData	LockBits (Rectangle rect, ImageLockMode flags, PixelFormat format)
	This function is not yet implemented. More...
BitmapData	LockBits (Rectangle rect, ImageLockMode flags, PixelFormat format, BitmapData bitmapData)
	This function is not yet implemented. More...
void	UnlockBits (BitmapData bitmapdata)
	This function is not yet implemented. More...
bool	ConvertColorDepth (FREE_IMAGE_COLOR_DEPTH bpp)
	Converts this FreeImageBitmap into a different color depth. The parameter bpp specifies color depth, greyscale conversion and palette reorder. More...
bool	ConvertType (FREE_IMAGE_TYPE type, bool scaleLinear)
	Converts this FreeImageBitmap FREE_IMAGE_TYPE to type initializing a new instance. In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event. More...
FreeImageBitmap	GetTypeConvertedInstance (FREE_IMAGE_TYPE type, bool scaleLinear)
	Converts this FreeImageBitmap FreeImageBitmap to type . In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event. More...
FreeImageBitmap	GetColorConvertedInstance (FREE_IMAGE_COLOR_DEPTH bpp)
	Converts this FreeImageBitmap into a different color depth initializing a new instance. The parameter bpp specifies color depth, greyscale conversion and palette reorder. More...
bool	Rescale (Size newSize, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter. More...
bool	Rescale (int width, int height, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter. More...
FreeImageBitmap	GetScaledInstance (Size newSize, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance. More...
FreeImageBitmap	GetScaledInstance (int width, int height, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance. More...
bool	EnlargeCanvas< T > (int left, int top, int right, int bottom, T?color)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
bool	EnlargeCanvas< T > (int left, int top, int right, int bottom, T?color, FREE_IMAGE_COLOR_OPTIONS options)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
FreeImageBitmap	GetEnlargedInstance< T > (int left, int top, int right, int bottom, T?color)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
FreeImageBitmap	GetEnlargedInstance< T > (int left, int top, int right, int bottom, T?color, FREE_IMAGE_COLOR_OPTIONS options)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm . More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length. More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length. More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, RGBQUAD[] reservePalette)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length. More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm initializing a new 8 bit instance with the specified paletteSize . More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and reservePalette palette initializing a new 8 bit instance with the specified paletteSize . More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize . More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, RGBQUAD[] reservePalette)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize . More...
bool	TmoDrago03 (double gamma, double exposure)
	Converts a High Dynamic Range image to a 24-bit RGB image using a global operator based on logarithmic compression of luminance values, imitating the human response to light. More...
bool	TmoReinhard05 (double intensity, double contrast)
	Converts a High Dynamic Range image to a 24-bit RGB image using a global operator inspired by photoreceptor physiology of the human visual system. More...
bool	TmoFattal02 (double color_saturation, double attenuation)
	Apply the Gradient Domain High Dynamic Range Compression to a RGBF image and convert to 24-bit RGB. More...
bool	Rotate (double angle)
	This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
bool	Rotate< T > (double angle, T?backgroundColor)
	This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
FreeImageBitmap	GetRotatedInstance< T > (double angle, T?backgroundColor)
	Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
FreeImageBitmap	GetRotatedInstance (double angle)
	Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
bool	Rotate (double angle, double xShift, double yShift, double xOrigin, double yOrigin, bool useMask)
	This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline. More...
FreeImageBitmap	GetRotatedInstance (double angle, double xShift, double yShift, double xOrigin, double yOrigin, bool useMask)
	This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline initializing a new instance. More...
bool	AdjustCurve (byte[] lookUpTable, FREE_IMAGE_COLOR_CHANNEL channel)
	Perfoms an histogram transformation on a 8-, 24- or 32-bit image. More...
bool	AdjustGamma (double gamma)
	Performs gamma correction on a 8-, 24- or 32-bit image. More...
bool	AdjustBrightness (double percentage)
	Adjusts the brightness of a 8-, 24- or 32-bit image by a certain amount. More...
bool	AdjustContrast (double percentage)
	Adjusts the contrast of a 8-, 24- or 32-bit image by a certain amount. More...
bool	Invert ()
	Inverts each pixel data. More...
bool	GetHistogram (FREE_IMAGE_COLOR_CHANNEL channel, out int[] histogram)
	Computes the image histogram. More...
FreeImageBitmap	GetChannel (FREE_IMAGE_COLOR_CHANNEL channel)
	Retrieves the red, green, blue or alpha channel of a 24- or 32-bit image. More...
bool	SetChannel (FreeImageBitmap bitmap, FREE_IMAGE_COLOR_CHANNEL channel)
	Insert a 8-bit dib into a 24- or 32-bit image. Both images must have to same width and height. More...
FreeImageBitmap	GetComplexChannel (FREE_IMAGE_COLOR_CHANNEL channel)
	Retrieves the real part, imaginary part, magnitude or phase of a complex image. More...
bool	SetComplexChannel (FreeImageBitmap bitmap, FREE_IMAGE_COLOR_CHANNEL channel)
	Set the real or imaginary part of a complex image. Both images must have to same width and height. More...
FreeImageBitmap	Copy (Rectangle rect)
	Copy a sub part of this FreeImageBitmap. More...
FreeImageBitmap	Copy (int left, int top, int right, int bottom)
	Copy a sub part of this FreeImageBitmap. More...
bool	Paste (FreeImageBitmap bitmap, int left, int top, int alpha)
	Alpha blend or combine a sub part image with this FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance. More...
bool	Paste (FreeImageBitmap bitmap, Point point, int alpha)
	Alpha blend or combine a sub part image with tthis FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance. More...
bool	Composite (bool useBitmapBackground, Color?applicationBackground, FreeImageBitmap bitmapBackGround)
	This method composite a transparent foreground image against a single background color or against a background image. In case useBitmapBackground is false and applicationBackground and bitmapBackGround are null, a checkerboard will be used as background. More...
bool	PreMultiplyWithAlpha ()
	Applies the alpha value of each pixel to its color components. The aplha value stays unchanged. Only works with 32-bits color depth. More...
bool	MultigridPoissonSolver (int ncycle)
	Solves a Poisson equation, remap result pixels to [0..1] and returns the solution. More...
bool	AdjustColors (double brightness, double contrast, double gamma, bool invert)
	Adjusts an image's brightness, contrast and gamma as well as it may optionally invert the image within a single operation. More...
uint	ApplyColorMapping (RGBQUAD[] srccolors, RGBQUAD[] dstcolors, bool ignore_alpha, bool swap)
	Applies color mapping for one or several colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image. More...
uint	SwapColors (RGBQUAD color_a, RGBQUAD color_b, bool ignore_alpha)
	Swaps two specified colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image. More...
uint	ApplyPaletteIndexMapping (byte[] srcindices, byte[] dstindices, uint count, bool swap)
	Applies palette index mapping for one or several indices on a 1-, 4- or 8-bit palletized image. More...
uint	SwapPaletteIndices (byte index_a, byte index_b)
	Swaps two specified palette indices on a 1-, 4- or 8-bit palletized image. More...
bool	FillBackground< T > (T color)
	Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details. More...
bool	FillBackground< T > (T color, FREE_IMAGE_COLOR_OPTIONS options)
	Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details. More...
FIICCPROFILE	CreateICCProfile (byte[] data)
	Creates a new ICC-Profile. More...
FIICCPROFILE	CreateICCProfile (byte[] data, int size)
	Creates a new ICC-Profile. More...
override bool	Equals (object obj)
	Determines whether this and the specified instances are the same. More...
override int	GetHashCode ()
	Returns a hash code for this FreeImageBitmap structure. More...
object	Clone ()
	Creates a deep copy of this FreeImageBitmap. More...
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
	FreeImageBitmap (FreeImageBitmap original)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image. More...
	FreeImageBitmap (FreeImageBitmap original, Size newSize)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (FreeImageBitmap original, int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Image original)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image. More...
	FreeImageBitmap (Image original, Size newSize)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Image original, int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Bitmap original)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image. More...
	FreeImageBitmap (Bitmap original, Size newSize)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Bitmap original, int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size. More...
	FreeImageBitmap (Stream stream, bool useIcm)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream. More...
	FreeImageBitmap (Stream stream)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream. More...
	FreeImageBitmap (Stream stream, FREE_IMAGE_FORMAT format)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format. More...
	FreeImageBitmap (Stream stream, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream with the specified loading flags. More...
	FreeImageBitmap (Stream stream, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format with the specified loading flags. More...
	FreeImageBitmap (string filename)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file. More...
	FreeImageBitmap (string filename, bool useIcm)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file. More...
	FreeImageBitmap (string filename, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file with the specified loading flags. More...
	FreeImageBitmap (string filename, FREE_IMAGE_FORMAT format)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format. More...
	FreeImageBitmap (string filename, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS flags)
	Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format with the specified loading flags. More...
	FreeImageBitmap (int width, int height)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size. More...
	FreeImageBitmap (Type type, string resource)
	Initializes a new instance of the FreeImageBitmap class bases on the specified resource. More...
	FreeImageBitmap (int width, int height, Graphics g)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size and with the resolution of the specified System.Drawing.Graphics object. More...
	FreeImageBitmap (int width, int height, PixelFormat format)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size and format. More...
	FreeImageBitmap (int width, int height, FREE_IMAGE_TYPE type)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size and type. Only non standard bitmaps are supported. More...
	FreeImageBitmap (int width, int height, int stride, PixelFormat format, IntPtr scan0)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (int width, int height, int stride, PixelFormat format, byte[] bits)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (int width, int height, int stride, int bpp, FREE_IMAGE_TYPE type, IntPtr scan0)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (int width, int height, int stride, int bpp, FREE_IMAGE_TYPE type, byte[] bits)
	Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data. More...
	FreeImageBitmap (SerializationInfo info, StreamingContext context)
	Initializes a new instance of the FreeImageBitmap class. More...
RectangleF	GetBounds (ref GraphicsUnit pageUnit)
	Gets the bounds of this FreeImageBitmap in the specified unit. More...
PropertyItem	GetPropertyItem (int propid)
	Gets the specified property item from this FreeImageBitmap. More...
FreeImageBitmap	GetThumbnailImage (int thumbWidth, int thumbHeight, Image.GetThumbnailImageAbort callback, IntPtr callBackData)
	Returns a thumbnail for this FreeImageBitmap. More...
FreeImageBitmap	GetThumbnailImage (int maxPixelSize, bool convert)
	Returns a thumbnail for this FreeImageBitmap, keeping aspect ratio. maxPixelSize defines the maximum width or height of the thumbnail. More...
Bitmap	ToBitmap ()
	Converts this FreeImageBitmap instance to a Bitmap instance. More...
Scanline< T >	GetScanline< T > (int scanline)
	Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image. More...
object	GetScanline (int scanline)
	Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image. More...
IntPtr	GetScanlinePointer (int scanline)
	Returns a pointer to the specified scanline. Due to FreeImage bitmaps are bottum up, scanline 0 is the most bottom line of the image. More...
IList	GetScanlines ()
	Returns a list of structures, representing the scanlines of this FreeImageBitmap. Due to FreeImage bitmaps are bottum up, scanline 0 is the bottom-most line of the image. Each color depth has a different representing structure due to different memory layouts. More...
void	RemovePropertyItem (int propid)
	Removes the specified property item from this FreeImageBitmap. More...
void	RotateFlip (RotateFlipType rotateFlipType)
	This method rotates, flips, or rotates and flips this FreeImageBitmap. More...
void	CloneMetadataFrom (FreeImageBitmap bitmap)
	Copies the metadata from another FreeImageBitmap. More...
void	CloneMetadataFrom (FreeImageBitmap bitmap, FREE_IMAGE_METADATA_COPY flags)
	Copies the metadata from another FreeImageBitmap using the provided options. More...
void	Save (string filename)
	Saves this FreeImageBitmap to the specified file. More...
void	Save (string filename, FREE_IMAGE_FORMAT format)
	Saves this FreeImageBitmap to the specified file in the specified format. More...
void	Save (string filename, FREE_IMAGE_FORMAT format, FREE_IMAGE_SAVE_FLAGS flags)
	Saves this FreeImageBitmap to the specified file in the specified format using the specified saving flags. More...
void	Save (Stream stream, FREE_IMAGE_FORMAT format)
	Saves this FreeImageBitmap to the specified stream in the specified format. More...
void	Save (Stream stream, FREE_IMAGE_FORMAT format, FREE_IMAGE_SAVE_FLAGS flags)
	Saves this FreeImageBitmap to the specified stream in the specified format using the specified saving flags. More...
void	SaveAdd ()
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (int insertPosition)
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (FreeImageBitmap bitmap)
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (FreeImageBitmap bitmap, int insertPosition)
	Adds a frame to the file specified in a previous call to the Save(String) method. More...
void	SaveAdd (string filename)
	Adds a frame to the file specified. More...
void	SaveAdd (string filename, int insertPosition)
	Adds a frame to the file specified. More...
void	SaveAdd (string filename, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a frame to the file specified using the specified parameters. More...
void	SaveAdd (string filename, int insertPosition, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a frame to the file specified using the specified parameters. More...
void	SelectActiveFrame (int frameIndex)
	Selects the frame specified by the index. More...
IntPtr	GetHbitmap ()
	Creates a GDI bitmap object from this FreeImageBitmap. More...
IntPtr	GetHbitmap (Color background)
	Creates a GDI bitmap object from this FreeImageBitmap. More...
IntPtr	GetHicon ()
	Returns the handle to an icon. More...
IntPtr	GetHbitmapForDevice ()
	Creates a GDI bitmap object from this FreeImageBitmap with the same color depth as the primary device. More...
unsafe Color	GetPixel (int x, int y)
	Gets the Color of the specified pixel in this FreeImageBitmap. More...
void	MakeTransparent ()
	Makes the default transparent color transparent for this FreeImageBitmap. More...
void	MakeTransparent (Color transparentColor)
	Makes the specified color transparent for this FreeImageBitmap. More...
unsafe void	SetPixel (int x, int y, Color color)
	Sets the System.Drawing.Color of the specified pixel in this FreeImageBitmap. More...
void	SetResolution (float xDpi, float yDpi)
	Sets the resolution for this FreeImageBitmap. More...
BitmapData	LockBits (Rectangle rect, ImageLockMode flags, PixelFormat format)
	This function is not yet implemented. More...
BitmapData	LockBits (Rectangle rect, ImageLockMode flags, PixelFormat format, BitmapData bitmapData)
	This function is not yet implemented. More...
void	UnlockBits (BitmapData bitmapdata)
	This function is not yet implemented. More...
bool	ConvertColorDepth (FREE_IMAGE_COLOR_DEPTH bpp)
	Converts this FreeImageBitmap into a different color depth. The parameter bpp specifies color depth, greyscale conversion and palette reorder. More...
bool	ConvertType (FREE_IMAGE_TYPE type, bool scaleLinear)
	Converts this FreeImageBitmap FREE_IMAGE_TYPE to type initializing a new instance. In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event. More...
FreeImageBitmap	GetTypeConvertedInstance (FREE_IMAGE_TYPE type, bool scaleLinear)
	Converts this FreeImageBitmap FreeImageBitmap to type . In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event. More...
FreeImageBitmap	GetColorConvertedInstance (FREE_IMAGE_COLOR_DEPTH bpp)
	Converts this FreeImageBitmap into a different color depth initializing a new instance. The parameter bpp specifies color depth, greyscale conversion and palette reorder. More...
bool	Rescale (Size newSize, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter. More...
bool	Rescale (int width, int height, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter. More...
FreeImageBitmap	GetScaledInstance (Size newSize, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance. More...
FreeImageBitmap	GetScaledInstance (int width, int height, FREE_IMAGE_FILTER filter)
	Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance. More...
bool	EnlargeCanvas< T > (int left, int top, int right, int bottom, T?color)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
bool	EnlargeCanvas< T > (int left, int top, int right, int bottom, T?color, FREE_IMAGE_COLOR_OPTIONS options)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
FreeImageBitmap	GetEnlargedInstance< T > (int left, int top, int right, int bottom, T?color)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
FreeImageBitmap	GetEnlargedInstance< T > (int left, int top, int right, int bottom, T?color, FREE_IMAGE_COLOR_OPTIONS options)
	Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details. More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm . More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length. More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length. More...
bool	Quantize (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, RGBQUAD[] reservePalette)
	Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length. More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm initializing a new 8 bit instance with the specified paletteSize . More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and reservePalette palette initializing a new 8 bit instance with the specified paletteSize . More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, Palette reservePalette)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize . More...
FreeImageBitmap	GetQuantizedInstance (FREE_IMAGE_QUANTIZE algorithm, int paletteSize, int reserveSize, RGBQUAD[] reservePalette)
	Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize . More...
bool	TmoDrago03 (double gamma, double exposure)
	Converts a High Dynamic Range image to a 24-bit RGB image using a global operator based on logarithmic compression of luminance values, imitating the human response to light. More...
bool	TmoReinhard05 (double intensity, double contrast)
	Converts a High Dynamic Range image to a 24-bit RGB image using a global operator inspired by photoreceptor physiology of the human visual system. More...
bool	TmoFattal02 (double color_saturation, double attenuation)
	Apply the Gradient Domain High Dynamic Range Compression to a RGBF image and convert to 24-bit RGB. More...
bool	Rotate (double angle)
	This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
bool	Rotate< T > (double angle, T?backgroundColor)
	This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
FreeImageBitmap	GetRotatedInstance< T > (double angle, T?backgroundColor)
	Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
FreeImageBitmap	GetRotatedInstance (double angle)
	Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90. More...
bool	Rotate (double angle, double xShift, double yShift, double xOrigin, double yOrigin, bool useMask)
	This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline. More...
FreeImageBitmap	GetRotatedInstance (double angle, double xShift, double yShift, double xOrigin, double yOrigin, bool useMask)
	This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline initializing a new instance. More...
bool	AdjustCurve (byte[] lookUpTable, FREE_IMAGE_COLOR_CHANNEL channel)
	Perfoms an histogram transformation on a 8-, 24- or 32-bit image. More...
bool	AdjustGamma (double gamma)
	Performs gamma correction on a 8-, 24- or 32-bit image. More...
bool	AdjustBrightness (double percentage)
	Adjusts the brightness of a 8-, 24- or 32-bit image by a certain amount. More...
bool	AdjustContrast (double percentage)
	Adjusts the contrast of a 8-, 24- or 32-bit image by a certain amount. More...
bool	Invert ()
	Inverts each pixel data. More...
bool	GetHistogram (FREE_IMAGE_COLOR_CHANNEL channel, out int[] histogram)
	Computes the image histogram. More...
FreeImageBitmap	GetChannel (FREE_IMAGE_COLOR_CHANNEL channel)
	Retrieves the red, green, blue or alpha channel of a 24- or 32-bit image. More...
bool	SetChannel (FreeImageBitmap bitmap, FREE_IMAGE_COLOR_CHANNEL channel)
	Insert a 8-bit dib into a 24- or 32-bit image. Both images must have to same width and height. More...
FreeImageBitmap	GetComplexChannel (FREE_IMAGE_COLOR_CHANNEL channel)
	Retrieves the real part, imaginary part, magnitude or phase of a complex image. More...
bool	SetComplexChannel (FreeImageBitmap bitmap, FREE_IMAGE_COLOR_CHANNEL channel)
	Set the real or imaginary part of a complex image. Both images must have to same width and height. More...
FreeImageBitmap	Copy (Rectangle rect)
	Copy a sub part of this FreeImageBitmap. More...
FreeImageBitmap	Copy (int left, int top, int right, int bottom)
	Copy a sub part of this FreeImageBitmap. More...
bool	Paste (FreeImageBitmap bitmap, int left, int top, int alpha)
	Alpha blend or combine a sub part image with this FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance. More...
bool	Paste (FreeImageBitmap bitmap, Point point, int alpha)
	Alpha blend or combine a sub part image with tthis FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance. More...
bool	Composite (bool useBitmapBackground, Color?applicationBackground, FreeImageBitmap bitmapBackGround)
	This method composite a transparent foreground image against a single background color or against a background image. In case useBitmapBackground is false and applicationBackground and bitmapBackGround are null, a checkerboard will be used as background. More...
bool	PreMultiplyWithAlpha ()
	Applies the alpha value of each pixel to its color components. The aplha value stays unchanged. Only works with 32-bits color depth. More...
bool	MultigridPoissonSolver (int ncycle)
	Solves a Poisson equation, remap result pixels to [0..1] and returns the solution. More...
bool	AdjustColors (double brightness, double contrast, double gamma, bool invert)
	Adjusts an image's brightness, contrast and gamma as well as it may optionally invert the image within a single operation. More...
uint	ApplyColorMapping (RGBQUAD[] srccolors, RGBQUAD[] dstcolors, bool ignore_alpha, bool swap)
	Applies color mapping for one or several colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image. More...
uint	SwapColors (RGBQUAD color_a, RGBQUAD color_b, bool ignore_alpha)
	Swaps two specified colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image. More...
uint	ApplyPaletteIndexMapping (byte[] srcindices, byte[] dstindices, uint count, bool swap)
	Applies palette index mapping for one or several indices on a 1-, 4- or 8-bit palletized image. More...
uint	SwapPaletteIndices (byte index_a, byte index_b)
	Swaps two specified palette indices on a 1-, 4- or 8-bit palletized image. More...
bool	FillBackground< T > (T color)
	Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details. More...
bool	FillBackground< T > (T color, FREE_IMAGE_COLOR_OPTIONS options)
	Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details. More...
FIICCPROFILE	CreateICCProfile (byte[] data)
	Creates a new ICC-Profile. More...
FIICCPROFILE	CreateICCProfile (byte[] data, int size)
	Creates a new ICC-Profile. More...
override bool	Equals (object obj)
	Determines whether this and the specified instances are the same. More...
override int	GetHashCode ()
	Returns a hash code for this FreeImageBitmap structure. More...
object	Clone ()
	Creates a deep copy of this FreeImageBitmap. More...
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Static Public Member Functions
static	operator Bitmap (FreeImageBitmap value)
	Converts a FreeImageBitmap instance to a Bitmap instance. More...
static	operator FreeImageBitmap (Bitmap value)
	Converts a Bitmap instance to a FreeImageBitmap instance. More...
static bool	operator== (FreeImageBitmap left, FreeImageBitmap right)
	Determines whether two specified FreeImageBitmap objects have the same value. More...
static bool	operator!= (FreeImageBitmap left, FreeImageBitmap right)
	Determines whether two specified FreeImageBitmap objects have different values. More...
static bool	IsAlphaPixelFormat (PixelFormat pixfmt)
	Returns a value that indicates whether the pixel format for this FreeImageBitmap contains alpha information. More...
static bool	IsCanonicalPixelFormat (PixelFormat pixfmt)
	Returns a value that indicates whether the pixel format is 32 bits per pixel. More...
static bool	IsExtendedPixelFormat (PixelFormat pixfmt)
	Returns a value that indicates whether the pixel format is 64 bits per pixel. More...
static FreeImageBitmap	FromHicon (IntPtr hicon)
	Creates a FreeImageBitmap from a Windows handle to an icon. More...
static FreeImageBitmap	FromResource (IntPtr hinstance, string bitmapName)
	Creates a FreeImageBitmap from the specified Windows resource. More...
static FreeImageBitmap	FromFile (string filename)
	Creates a FreeImageBitmap from the specified file. More...
static FreeImageBitmap	FromFile (string filename, bool useEmbeddedColorManagement)
	Creates a FreeImageBitmap from the specified file using embedded color management information in that file. More...
static FreeImageBitmap	FromHbitmap (IntPtr hbitmap)
	Creates a FreeImageBitmap from a handle to a GDI bitmap. More...
static FreeImageBitmap	FromHbitmap (IntPtr hbitmap, IntPtr hpalette)
	Creates a FreeImageBitmap from a handle to a GDI bitmap and a handle to a GDI palette. More...
static bool	FreeHbitmap (IntPtr hbitmap)
	Frees a bitmap handle. More...
static FreeImageBitmap	FromStream (Stream stream)
	Creates a FreeImageBitmap from the specified data stream. More...
static FreeImageBitmap	FromStream (Stream stream, bool useEmbeddedColorManagement)
	Creates a FreeImageBitmap from the specified data stream. More...
static FreeImageBitmap	FromStream (Stream stream, bool useEmbeddedColorManagement, bool validateImageData)
	Creates a FreeImageBitmap from the specified data stream. More...
static int	GetPixelFormatSize (PixelFormat pixfmt)
	Returns the color depth, in number of bits per pixel, of the specified pixel format. More...
static bool	JPEGTransform (string source, string destination, FREE_IMAGE_JPEG_OPERATION operation, bool perfect)
	Performs a lossless rotation or flipping on a JPEG file. More...
static bool	JPEGCrop (string source, string destination, Rectangle rect)
	Performs a lossless crop on a JPEG file. More...
static bool	JPEGCrop (string source, string destination, int left, int top, int right, int bottom)
	Performs a lossless crop on a JPEG file. More...
static bool	LookupX11Color (string color, out byte red, out byte green, out byte blue)
	Converts a X11 color name into a corresponding RGB value. More...
static bool	LookupSVGColor (string color, out byte red, out byte green, out byte blue)
	Converts a SVG color name into a corresponding RGB value. More...
static int	GetAdjustColorsLookupTable (byte[] lookUpTable, double brightness, double contrast, double gamma, bool invert)
	Creates a lookup table to be used with AdjustCurve() which may adjusts brightness and contrast, correct gamma and invert the image with a single call to AdjustCurve(). More...
static void	SaveAdd (string filename, FreeImageBitmap bitmap, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an to a multiple-frame image. More...
static void	SaveAdd (string filename, FreeImageBitmap bitmap, int insertPosition, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an image to a multiple-frame image. More...
static PropertyItem	CreateNewPropertyItem ()
	Returns a new instance of the PropertyItem class which has no public accessible constructor. More...
static	operator Bitmap (FreeImageBitmap value)
	Converts a FreeImageBitmap instance to a Bitmap instance. More...
static	operator FreeImageBitmap (Bitmap value)
	Converts a Bitmap instance to a FreeImageBitmap instance. More...
static bool	operator== (FreeImageBitmap left, FreeImageBitmap right)
	Determines whether two specified FreeImageBitmap objects have the same value. More...
static bool	operator!= (FreeImageBitmap left, FreeImageBitmap right)
	Determines whether two specified FreeImageBitmap objects have different values. More...
static bool	IsAlphaPixelFormat (PixelFormat pixfmt)
	Returns a value that indicates whether the pixel format for this FreeImageBitmap contains alpha information. More...
static bool	IsCanonicalPixelFormat (PixelFormat pixfmt)
	Returns a value that indicates whether the pixel format is 32 bits per pixel. More...
static bool	IsExtendedPixelFormat (PixelFormat pixfmt)
	Returns a value that indicates whether the pixel format is 64 bits per pixel. More...
static FreeImageBitmap	FromHicon (IntPtr hicon)
	Creates a FreeImageBitmap from a Windows handle to an icon. More...
static FreeImageBitmap	FromResource (IntPtr hinstance, string bitmapName)
	Creates a FreeImageBitmap from the specified Windows resource. More...
static FreeImageBitmap	FromFile (string filename)
	Creates a FreeImageBitmap from the specified file. More...
static FreeImageBitmap	FromFile (string filename, bool useEmbeddedColorManagement)
	Creates a FreeImageBitmap from the specified file using embedded color management information in that file. More...
static FreeImageBitmap	FromHbitmap (IntPtr hbitmap)
	Creates a FreeImageBitmap from a handle to a GDI bitmap. More...
static FreeImageBitmap	FromHbitmap (IntPtr hbitmap, IntPtr hpalette)
	Creates a FreeImageBitmap from a handle to a GDI bitmap and a handle to a GDI palette. More...
static bool	FreeHbitmap (IntPtr hbitmap)
	Frees a bitmap handle. More...
static FreeImageBitmap	FromStream (Stream stream)
	Creates a FreeImageBitmap from the specified data stream. More...
static FreeImageBitmap	FromStream (Stream stream, bool useEmbeddedColorManagement)
	Creates a FreeImageBitmap from the specified data stream. More...
static FreeImageBitmap	FromStream (Stream stream, bool useEmbeddedColorManagement, bool validateImageData)
	Creates a FreeImageBitmap from the specified data stream. More...
static int	GetPixelFormatSize (PixelFormat pixfmt)
	Returns the color depth, in number of bits per pixel, of the specified pixel format. More...
static bool	JPEGTransform (string source, string destination, FREE_IMAGE_JPEG_OPERATION operation, bool perfect)
	Performs a lossless rotation or flipping on a JPEG file. More...
static bool	JPEGCrop (string source, string destination, Rectangle rect)
	Performs a lossless crop on a JPEG file. More...
static bool	JPEGCrop (string source, string destination, int left, int top, int right, int bottom)
	Performs a lossless crop on a JPEG file. More...
static bool	LookupX11Color (string color, out byte red, out byte green, out byte blue)
	Converts a X11 color name into a corresponding RGB value. More...
static bool	LookupSVGColor (string color, out byte red, out byte green, out byte blue)
	Converts a SVG color name into a corresponding RGB value. More...
static int	GetAdjustColorsLookupTable (byte[] lookUpTable, double brightness, double contrast, double gamma, bool invert)
	Creates a lookup table to be used with AdjustCurve() which may adjusts brightness and contrast, correct gamma and invert the image with a single call to AdjustCurve(). More...
static void	SaveAdd (string filename, FreeImageBitmap bitmap, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an to a multiple-frame image. More...
static void	SaveAdd (string filename, FreeImageBitmap bitmap, int insertPosition, FREE_IMAGE_FORMAT format, FREE_IMAGE_LOAD_FLAGS loadFlags, FREE_IMAGE_SAVE_FLAGS saveFlags)
	Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an image to a multiple-frame image. More...
static PropertyItem	CreateNewPropertyItem ()
	Returns a new instance of the PropertyItem class which has no public accessible constructor. More...

Protected Member Functions
	FreeImageBitmap ()
	Initializes a new instance of the FreeImageBitmap class. More...
	FreeImageBitmap (FIBITMAP dib)
	Initializes a new instance of the FreeImageBitmap class. For internal use only. More...
virtual void	Dispose (bool disposing)
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
	FreeImageBitmap ()
	Initializes a new instance of the FreeImageBitmap class. More...
	FreeImageBitmap (FIBITMAP dib)
	Initializes a new instance of the FreeImageBitmap class. For internal use only. More...
virtual void	Dispose (bool disposing)
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Properties
FREE_IMAGE_TYPE	ImageType [get]
	Type of the bitmap. More...
int	ColorsUsed [get]
	Number of palette entries. More...
int	UniqueColors [get]
	The number of unique colors actually used by the bitmap. This might be different from what ColorsUsed returns, which actually returns the palette size for palletised images. Works for FIT_BITMAP type bitmaps only. More...
int	ColorDepth [get]
	The size of one pixel in the bitmap in bits. More...
int	Width [get]
	Width of the bitmap in pixel units. More...
int	Height [get]
	Height of the bitmap in pixel units. More...
int	Pitch [get]
	Returns the width of the bitmap in bytes, rounded to the next 32-bit boundary. More...
int	DataSize [get]
	Size of the bitmap in memory. More...
Palette	Palette [get]
	Returns a structure that represents the palette of a FreeImage bitmap. More...
bool	ISRgb555 [get]
	Gets whether the bitmap is RGB 555. More...
bool	ISRgb565 [get]
	Gets whether the bitmap is RGB 565. More...
float	HorizontalResolution [get, set]
	Gets the horizontal resolution, in pixels per inch, of this FreeImageBitmap. More...
float	VerticalResolution [get, set]
	Gets the vertical resolution, in pixels per inch, of this FreeImageBitmap. More...
BITMAPINFOHEADER	InfoHeader [get]
	Returns the BITMAPINFOHEADER structure of this FreeImageBitmap. More...
BITMAPINFO	Info [get]
	Returns the BITMAPINFO structure of a this FreeImageBitmap. More...
FREE_IMAGE_COLOR_TYPE	ColorType [get]
	Investigates the color type of this FreeImageBitmap by reading the bitmaps pixel bits and analysing them. More...
uint	RedMask [get]
	Bit pattern describing the red color component of a pixel in this FreeImageBitmap. More...
uint	GreenMask [get]
	Bit pattern describing the green color component of a pixel in this FreeImageBitmap. More...
uint	BlueMask [get]
	Bit pattern describing the blue color component of a pixel in this FreeImageBitmap. More...
int	TransparencyCount [get]
	Number of transparent colors in a palletised FreeImageBitmap. More...
byte[]	TransparencyTable [get, set]
	Get or sets transparency table of this FreeImageBitmap. More...
bool	IsTransparent [get, set]
	Gets or sets whether this FreeImageBitmap is transparent. More...
bool	HasBackgroundColor [get]
	Gets whether this FreeImageBitmap has a file background color. More...
Color	BackgroundColor [get, set]
	Gets or sets the background color of this FreeImageBitmap. In case the value is null, the background color is removed. More...
IntPtr	Bits [get]
	Pointer to the data-bits of this FreeImageBitmap. More...
int	Line [get]
	Width, in bytes, of this FreeImageBitmap. More...
IntPtr	Scan0 [get]
	Pointer to the scanline of the top most pixel row of this FreeImageBitmap. More...
int	Stride [get]
	Width, in bytes, of this FreeImageBitmap. In case this FreeImageBitmap is top down Stride will be positive, else negative. More...
unsafe int	Flags [get]
	Gets attribute flags for the pixel data of this FreeImageBitmap. More...
SizeF	PhysicalDimension [get]
	Gets the width and height of this FreeImageBitmap. More...
PixelFormat	PixelFormat [get]
	Gets the pixel format for this FreeImageBitmap. More...
int[]	PropertyIdList [get]
	Gets IDs of the property items stored in this FreeImageBitmap. More...
PropertyItem[]	PropertyItems [get]
	Gets all the property items (pieces of metadata) stored in this FreeImageBitmap. More...
ImageFormat	RawFormat [get]
	Gets the format of this FreeImageBitmap. More...
Size	Size [get]
	Gets the width and height, in pixels, of this FreeImageBitmap. More...
Object	Tag [get, set]
	Gets or sets an object that provides additional data about the FreeImageBitmap. More...
bool	IsDisposed [get]
	Gets whether this FreeImageBitmap has been disposed. More...
ImageMetadata	Metadata [get]
	Gets a new instance of a metadata representing class. More...
string	Comment [get, set]
	Gets or sets the comment of this FreeImageBitmap. Supported formats are JPEG, PNG and GIF. More...
bool	HasPalette [get]
	Returns whether this FreeImageBitmap has a palette. More...
int	TransparentIndex [get, set]
	Gets or sets the entry used as transparent color in this FreeImageBitmap. Only works for 1-, 4- and 8-bpp. More...
int	FrameCount [get]
	Gets the number of frames in this FreeImageBitmap. More...
FIICCPROFILE	ICCProfile [get]
	Gets the ICCProfile structure of this FreeImageBitmap. More...
FREE_IMAGE_FORMAT	ImageFormat [get]
	Gets the format of the original image in case this FreeImageBitmap was loaded from a file or stream. More...
FREE_IMAGE_TYPE ImageType	get
	Type of the bitmap. More...
bool	IsRGB555 [get]
	Gets whether the bitmap is RGB 555. More...
bool	IsRGB565 [get]
	Gets whether the bitmap is RGB 565. More...

Detailed Description

Encapsulates a FreeImage-bitmap.

Definition at line 54 of file FreeImageBitmap.cs.

Constructor & Destructor Documentation

FreeImageAPI.FreeImageBitmap.FreeImageBitmap ( )

protected

Initializes a new instance of the FreeImageBitmap class.

Definition at line 134 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.Clone(), FreeImageAPI.FreeImageBitmap.Copy(), FreeImageAPI.FreeImageBitmap.FromFile(), FreeImageAPI.FreeImageBitmap.FromHbitmap(), FreeImageAPI.FreeImageBitmap.FromHicon(), FreeImageAPI.FreeImageBitmap.FromResource(), FreeImageAPI.FreeImageBitmap.FromStream(), FreeImageAPI.FreeImageBitmap.GetChannel(), FreeImageAPI.FreeImageBitmap.GetColorConvertedInstance(), FreeImageAPI.FreeImageBitmap.GetComplexChannel(), FreeImageAPI.FreeImageBitmap.GetEnlargedInstance< T >(), FreeImageAPI.FreeImageBitmap.GetHbitmap(), FreeImageAPI.FreeImageBitmap.GetQuantizedInstance(), FreeImageAPI.FreeImageBitmap.GetRotatedInstance(), FreeImageAPI.FreeImageBitmap.GetRotatedInstance< T >(), FreeImageAPI.FreeImageBitmap.GetScaledInstance(), FreeImageAPI.FreeImageBitmap.GetThumbnailImage(), FreeImageAPI.FreeImageBitmap.GetTypeConvertedInstance(), and FreeImageAPI.FreeImageBitmap.operator FreeImageBitmap().

FreeImageAPI.FreeImageBitmap.FreeImageBitmap ( FIBITMAP  dib )

protected

Initializes a new instance of the FreeImageBitmap class. For internal use only.

Exceptions

Exception

The operation failed.

Definition at line 143 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

FreeImageBitmap

original

)

Initializes a new instance of the FreeImageBitmap class bases on the specified image.

Parameters

original

The original to clone from.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.

Definition at line 160 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	FreeImageBitmap	original,
		Size	newSize
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
newSize	The Size structure that represent the size of the new FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	newSize are less or equal zero.

Definition at line 188 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	FreeImageBitmap	original,
		int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
width	Width of the new FreeImageBitmap.
height	Height of the new FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 204 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

Image

original

)

Initializes a new instance of the FreeImageBitmap class bases on the specified image.

Parameters

original

The original to clone from.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception

The operation failed.

Definition at line 242 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Image	original,
		Size	newSize
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
newSize	The Size structure that represent the size of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	newSize or newSize are less or equal zero.

Definition at line 267 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Image	original,
		int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 291 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

Bitmap

original

)

Initializes a new instance of the FreeImageBitmap class bases on the specified image.

Parameters

original

The original to clone from.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

ArgumentNullException	original is a null reference.
Exception	The operation failed.

Definition at line 311 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Bitmap	original,
		Size	newSize
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
newSize	The Size structure that represent the size of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	newSize or newSize are less or equal zero.

Definition at line 346 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Bitmap	original,
		int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 370 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		bool	useIcm
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream.

Parameters

stream	Stream to read from.
useIcm	Ignored.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 410 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

Stream

stream

)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream.

Parameters

stream

Stream to read from.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 425 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		FREE_IMAGE_FORMAT	format
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format.

Parameters

stream	Stream to read from.
format	Format of the image.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 441 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream with the specified loading flags.

Parameters

stream	Stream to read from.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 457 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format with the specified loading flags.

Parameters

stream	Stream to read from.
format	Format of the image.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 475 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

string

filename

)

Initializes a new instance of the FreeImageBitmap class bases on the specified file.

Parameters

filename

The complete name of the file to load.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 493 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		bool	useIcm
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file.

Parameters

filename	The complete name of the file to load.
useIcm	Ignored.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 506 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file with the specified loading flags.

Parameters

filename	The complete name of the file to load.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 520 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		FREE_IMAGE_FORMAT	format
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format.

Parameters

filename	The complete name of the file to load.
format	Format of the image.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 534 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format with the specified loading flags.

Parameters

filename	The complete name of the file to load.
format	Format of the image.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 549 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.

Exceptions

Exception

The operation failed.

Definition at line 573 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Type	type,
		string	resource
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified resource.

Parameters

type	The class used to extract the resource.
resource	The name of the resource.

Exceptions

Exception

The operation failed.

Definition at line 595 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		Graphics	g
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size and with the resolution of the specified System.Drawing.Graphics object.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
g	The Graphics object that specifies the resolution for the new FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	g is a null reference.

Definition at line 609 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		PixelFormat	format
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size and format.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
format	The PixelFormat enumeration for the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 634 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		FREE_IMAGE_TYPE	type
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size and type. Only non standard bitmaps are supported.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
type	The type of the bitmap.

Exceptions

Exception	The operation failed.
ArgumentOutOfRangeException	type is FIT_BITMAP or FIT_UNKNOWN.
ArgumentException	type is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 671 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		PixelFormat	format,
		IntPtr	scan0
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
format	The PixelFormat enumeration for the new FreeImageBitmap.
scan0	Pointer to an array of bytes that contains the pixel data.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 718 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		PixelFormat	format,
		byte[]	bits
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
format	The PixelFormat enumeration for the new FreeImageBitmap.
bits	Array of bytes containing the bitmap data.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.
ArgumentNullException	bits is null

Definition at line 774 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		int	bpp,
		FREE_IMAGE_TYPE	type,
		IntPtr	scan0
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
bpp	The color depth of the new FreeImageBitmap
type	The type for the new FreeImageBitmap.
scan0	Pointer to an array of bytes that contains the pixel data.

Exceptions

Exception	The operation failed.
ArgumentException	is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 826 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		int	bpp,
		FREE_IMAGE_TYPE	type,
		byte[]	bits
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
bpp	The color depth of the new FreeImageBitmap
type	The type for the new FreeImageBitmap.
bits	Array of bytes containing the bitmap data.

Exceptions

Exception	The operation failed.
ArgumentException	is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.
ArgumentNullException	bits is null

Definition at line 874 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	SerializationInfo	info,
		StreamingContext	context
	)

Initializes a new instance of the FreeImageBitmap class.

Exceptions

Exception	The operation failed.
SerializationException	The operation failed.

Definition at line 912 of file FreeImageBitmap.cs.

References DirectX.format, and FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap ( )

protected

Initializes a new instance of the FreeImageBitmap class.

Definition at line 134 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap ( FIBITMAP  dib )

protected

Initializes a new instance of the FreeImageBitmap class. For internal use only.

Exceptions

Exception

The operation failed.

Definition at line 143 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

FreeImageBitmap

original

)

Initializes a new instance of the FreeImageBitmap class bases on the specified image.

Parameters

original

The original to clone from.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.

Definition at line 160 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	FreeImageBitmap	original,
		Size	newSize
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
newSize	The Size structure that represent the size of the new FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	newSize.Width or newSize.Height are less or equal zero.

Definition at line 188 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	FreeImageBitmap	original,
		int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
width	Width of the new FreeImageBitmap.
height	Height of the new FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 204 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

Image

original

)

Initializes a new instance of the FreeImageBitmap class bases on the specified image.

Parameters

original

The original to clone from.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception

The operation failed.

Definition at line 242 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Image	original,
		Size	newSize
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
newSize	The Size structure that represent the size of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	newSize.Width or newSize.Height are less or equal zero.

Definition at line 267 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Image	original,
		int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 291 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

Bitmap

original

)

Initializes a new instance of the FreeImageBitmap class bases on the specified image.

Parameters

original

The original to clone from.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

ArgumentNullException	original is a null reference.
Exception	The operation failed.

Definition at line 311 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Bitmap	original,
		Size	newSize
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
newSize	The Size structure that represent the size of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	newSize.Width or newSize.Height are less or equal zero.

Definition at line 346 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Bitmap	original,
		int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified image with the specified size.

Parameters

original	The original to clone from.
width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	original is a null reference.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 370 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		bool	useIcm
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream.

Parameters

stream	Stream to read from.
useIcm	Ignored.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 410 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

Stream

stream

)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream.

Parameters

stream

Stream to read from.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 425 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		FREE_IMAGE_FORMAT	format
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format.

Parameters

stream	Stream to read from.
format	Format of the image.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 441 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream with the specified loading flags.

Parameters

stream	Stream to read from.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 457 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Stream	stream,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified stream in the specified format with the specified loading flags.

Parameters

stream	Stream to read from.
format	Format of the image.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	stream is a null reference.

You must keep the stream open for the lifetime of the FreeImageBitmap.

Definition at line 475 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap

(

string

filename

)

Initializes a new instance of the FreeImageBitmap class bases on the specified file.

Parameters

filename

The complete name of the file to load.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 493 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		bool	useIcm
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file.

Parameters

filename	The complete name of the file to load.
useIcm	Ignored.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 506 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file with the specified loading flags.

Parameters

filename	The complete name of the file to load.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 520 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		FREE_IMAGE_FORMAT	format
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format.

Parameters

filename	The complete name of the file to load.
format	Format of the image.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 534 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	string	filename,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	flags
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified file in the specified format with the specified loading flags.

Parameters

filename	The complete name of the file to load.
format	Format of the image.
flags	Flags to enable or disable plugin-features.

Exceptions

Exception	The operation failed.
ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.

Definition at line 549 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.

Exceptions

Exception

The operation failed.

Definition at line 573 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	Type	type,
		string	resource
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified resource.

Parameters

type	The class used to extract the resource.
resource	The name of the resource.

Exceptions

Exception

The operation failed.

Definition at line 595 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		Graphics	g
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size and with the resolution of the specified System.Drawing.Graphics object.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
g	The Graphics object that specifies the resolution for the new FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentNullException	g is a null reference.

Definition at line 609 of file FreeImageBitmap.cs.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		PixelFormat	format
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size and format.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
format	The PixelFormat enumeration for the new FreeImageBitmap.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 634 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		FREE_IMAGE_TYPE	type
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size and type. Only non standard bitmaps are supported.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
type	The type of the bitmap.

Exceptions

Exception	The operation failed.
ArgumentOutOfRangeException	type is FIT_BITMAP or FIT_UNKNOWN.
ArgumentException	type is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 671 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		PixelFormat	format,
		IntPtr	scan0
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
format	The PixelFormat enumeration for the new FreeImageBitmap.
scan0	Pointer to an array of bytes that contains the pixel data.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 718 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		PixelFormat	format,
		byte[]	bits
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
format	The PixelFormat enumeration for the new FreeImageBitmap.
bits	Array of bytes containing the bitmap data.

Although this constructor supports creating images in both formats System.Drawing.Imaging.PixelFormat.Format32bppPArgb and System.Drawing.Imaging.PixelFormat.Format64bppPArgb, bitmaps created in these formats are treated like any normal 32-bit RGBA and 64-bit RGBA images respectively. Currently, there is no support for automatic premultiplying images in FreeImageBitmap.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.
ArgumentNullException	bits is null

Definition at line 774 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		int	bpp,
		FREE_IMAGE_TYPE	type,
		IntPtr	scan0
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
bpp	The color depth of the new FreeImageBitmap
type	The type for the new FreeImageBitmap.
scan0	Pointer to an array of bytes that contains the pixel data.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.

Definition at line 826 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	int	width,
		int	height,
		int	stride,
		int	bpp,
		FREE_IMAGE_TYPE	type,
		byte[]	bits
	)

Initializes a new instance of the FreeImageBitmap class bases on the specified size, pixel format and pixel data.

Parameters

width	The width, in pixels, of the new FreeImageBitmap.
height	The height, in pixels, of the new FreeImageBitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four..
bpp	The color depth of the new FreeImageBitmap
type	The type for the new FreeImageBitmap.
bits	Array of bytes containing the bitmap data.

Exceptions

Exception	The operation failed.
ArgumentException	format is invalid.
ArgumentOutOfRangeException	width or height are less or equal zero.
ArgumentNullException	bits is null

Definition at line 874 of file FreeImageBitmap.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.FreeImageBitmap.FreeImageBitmap	(	SerializationInfo	info,
		StreamingContext	context
	)

Initializes a new instance of the FreeImageBitmap class.

Exceptions

Exception	The operation failed.
SerializationException	The operation failed.

Definition at line 912 of file FreeImageBitmap.cs.

References DirectX.format, and FreeImageAPI.FIBITMAP.IsNull.

Member Function Documentation

bool FreeImageAPI.FreeImageBitmap.AdjustBrightness

(

double

percentage

)

Adjusts the brightness of a 8-, 24- or 32-bit image by a certain amount.

Parameters

percentage

A value 0 means no change, less than 0 will make the image darker and greater than 0 will make the image brighter.

Returns

Returns true on success, false on failure.

Definition at line 3311 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustBrightness

(

double

percentage

)

Adjusts the brightness of a 8-, 24- or 32-bit image by a certain amount.

Parameters

percentage

A value 0 means no change, less than 0 will make the image darker and greater than 0 will make the image brighter.

Returns

Returns true on success, false on failure.

Definition at line 3311 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustColors	(	double	brightness,
		double	contrast,
		double	gamma,
		bool	invert
	)

Adjusts an image's brightness, contrast and gamma as well as it may optionally invert the image within a single operation.

Parameters

brightness

Percentage brightness value where -100 <= brightness <= 100.

A value of 0 means no change, less than 0 will make the image darker and greater than 0 will make the image brighter.

Parameters

contrast

Percentage contrast value where -100 <= contrast <= 100.

A value of 0 means no change, less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image.

Parameters

gamma

Gamma value to be used for gamma correction.

A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it.

This parameter must not be zero or smaller than zero. If so, it will be ignored and no gamma correction will be performed on the image.

Parameters

invert

If set to true, the image will be inverted.

Returns

Returns true on success, false on failure.

Definition at line 3546 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustColors	(	double	brightness,
		double	contrast,
		double	gamma,
		bool	invert
	)

Adjusts an image's brightness, contrast and gamma as well as it may optionally invert the image within a single operation.

Parameters

brightness

Percentage brightness value where -100 <= brightness <= 100.

A value of 0 means no change, less than 0 will make the image darker and greater than 0 will make the image brighter.

Parameters

contrast

Percentage contrast value where -100 <= contrast <= 100.

A value of 0 means no change, less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image.

Parameters

gamma

Gamma value to be used for gamma correction.

A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it.

This parameter must not be zero or smaller than zero. If so, it will be ignored and no gamma correction will be performed on the image.

Parameters

invert

If set to true, the image will be inverted.

Returns

Returns true on success, false on failure.

Definition at line 3546 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustContrast

(

double

percentage

)

Adjusts the contrast of a 8-, 24- or 32-bit image by a certain amount.

Parameters

percentage

A value 0 means no change, less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image.

Returns

Returns true on success, false on failure.

Definition at line 3323 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustContrast

(

double

percentage

)

Adjusts the contrast of a 8-, 24- or 32-bit image by a certain amount.

Parameters

percentage

A value 0 means no change, less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image.

Returns

Returns true on success, false on failure.

Definition at line 3323 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustCurve	(	byte[]	lookUpTable,
		FREE_IMAGE_COLOR_CHANNEL	channel
	)

Perfoms an histogram transformation on a 8-, 24- or 32-bit image.

Parameters

lookUpTable	The lookup table (LUT). It's size is assumed to be 256 in length.
channel	The color channel to be transformed.

Returns

Returns true on success, false on failure.

Definition at line 3287 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustCurve	(	byte[]	lookUpTable,
		FREE_IMAGE_COLOR_CHANNEL	channel
	)

Perfoms an histogram transformation on a 8-, 24- or 32-bit image.

Parameters

lookUpTable	The lookup table (LUT). It's size is assumed to be 256 in length.
channel	The color channel to be transformed.

Returns

Returns true on success, false on failure.

Definition at line 3287 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustGamma

(

double

gamma

)

Performs gamma correction on a 8-, 24- or 32-bit image.

Parameters

gamma

The parameter represents the gamma value to use (gamma > 0). A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it.

Returns

Returns true on success, false on failure.

Definition at line 3299 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.AdjustGamma

(

double

gamma

)

Performs gamma correction on a 8-, 24- or 32-bit image.

Parameters

gamma

The parameter represents the gamma value to use (gamma > 0). A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it.

Returns

Returns true on success, false on failure.

Definition at line 3299 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.ApplyColorMapping	(	RGBQUAD[]	srccolors,
		RGBQUAD[]	dstcolors,
		bool	ignore_alpha,
		bool	swap
	)

Applies color mapping for one or several colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image.

Parameters

srccolors	Array of colors to be used as the mapping source.
dstcolors	Array of colors to be used as the mapping destination.
ignore_alpha	If true, 32-bit images and colors are treated as 24-bit.
swap	If true, source and destination colors are swapped, that is, each destination color is also mapped to the corresponding source color.

Returns

The total number of pixels changed.

Exceptions

ArgumentNullException	srccolors or dstcolors is a null reference.
ArgumentException	srccolors has a different length than dstcolors .

Definition at line 3568 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.ApplyColorMapping	(	RGBQUAD[]	srccolors,
		RGBQUAD[]	dstcolors,
		bool	ignore_alpha,
		bool	swap
	)

Applies color mapping for one or several colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image.

Parameters

srccolors	Array of colors to be used as the mapping source.
dstcolors	Array of colors to be used as the mapping destination.
ignore_alpha	If true, 32-bit images and colors are treated as 24-bit.
swap	If true, source and destination colors are swapped, that is, each destination color is also mapped to the corresponding source color.

Returns

The total number of pixels changed.

Exceptions

ArgumentNullException	srccolors or dstcolors is a null reference.
ArgumentException	srccolors has a different length than dstcolors .

Definition at line 3568 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.ApplyPaletteIndexMapping	(	byte[]	srcindices,
		byte[]	dstindices,
		uint	count,
		bool	swap
	)

Applies palette index mapping for one or several indices on a 1-, 4- or 8-bit palletized image.

Parameters

srcindices	Array of palette indices to be used as the mapping source.
dstindices	Array of palette indices to be used as the mapping destination.
count	The number of palette indices to be mapped. This is the size of both srcindices and dstindices
swap	If true, source and destination palette indices are swapped, that is, each destination index is also mapped to the corresponding source index.

Returns

The total number of pixels changed.

Exceptions

ArgumentNullException
ArgumentException

Definition at line 3615 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.ApplyPaletteIndexMapping	(	byte[]	srcindices,
		byte[]	dstindices,
		uint	count,
		bool	swap
	)

Applies palette index mapping for one or several indices on a 1-, 4- or 8-bit palletized image.

Parameters

srcindices	Array of palette indices to be used as the mapping source.
dstindices	Array of palette indices to be used as the mapping destination.
count	The number of palette indices to be mapped. This is the size of both srcindices and dstindices
swap	If true, source and destination palette indices are swapped, that is, each destination index is also mapped to the corresponding source index.

Returns

The total number of pixels changed.

Exceptions

ArgumentNullException	srccolors or dstcolors is a null reference.
ArgumentException	srccolors has a different length than dstcolors .

Definition at line 3617 of file FreeImageBitmap.cs.

object FreeImageAPI.FreeImageBitmap.Clone

(

)

Creates a deep copy of this FreeImageBitmap.

Returns

A deep copy of this FreeImageBitmap.

Definition at line 4288 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

object FreeImageAPI.FreeImageBitmap.Clone

(

)

Creates a deep copy of this FreeImageBitmap.

Returns

A deep copy of this FreeImageBitmap.

Definition at line 4290 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

void FreeImageAPI.FreeImageBitmap.CloneMetadataFrom

(

FreeImageBitmap

bitmap

)

Copies the metadata from another FreeImageBitmap.

Parameters

bitmap

The bitmap to read the metadata from.

Exceptions

ArgumentNullException

bitmap is a null reference.

Definition at line 2176 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.CloneMetadataFrom

(

FreeImageBitmap

bitmap

)

Copies the metadata from another FreeImageBitmap.

Parameters

bitmap

The bitmap to read the metadata from.

Exceptions

ArgumentNullException

bitmap is a null reference.

Definition at line 2176 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.CloneMetadataFrom	(	FreeImageBitmap	bitmap,
		FREE_IMAGE_METADATA_COPY	flags
	)

Copies the metadata from another FreeImageBitmap using the provided options.

Parameters

bitmap	The bitmap to read the metadata from.
flags	Specifies the way the metadata is copied.

Exceptions

ArgumentNullException

bitmap is a null reference.

Definition at line 2196 of file FreeImageBitmap.cs.

References DirectX.flags.

void FreeImageAPI.FreeImageBitmap.CloneMetadataFrom	(	FreeImageBitmap	bitmap,
		FREE_IMAGE_METADATA_COPY	flags
	)

Copies the metadata from another FreeImageBitmap using the provided options.

Parameters

bitmap	The bitmap to read the metadata from.
flags	Specifies the way the metadata is copied.

Exceptions

ArgumentNullException

bitmap is a null reference.

Definition at line 2196 of file FreeImageBitmap.cs.

References DirectX.flags.

bool FreeImageAPI.FreeImageBitmap.Composite	(	bool	useBitmapBackground,
		Color?	applicationBackground,
		FreeImageBitmap	bitmapBackGround
	)

This method composite a transparent foreground image against a single background color or against a background image. In case useBitmapBackground is false and applicationBackground and bitmapBackGround are null, a checkerboard will be used as background.

Parameters

useBitmapBackground	When true the background of this instance is used if it contains one.
applicationBackground	Backgroundcolor used in case useBitmapBackground is false and applicationBackground is not null.
bitmapBackGround	Background used in case useBitmapBackground is false and applicationBackground is a null reference.

Returns

Returns true on success, false on failure.

Definition at line 3493 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Composite	(	bool	useBitmapBackground,
		Color?	applicationBackground,
		FreeImageBitmap	bitmapBackGround
	)

This method composite a transparent foreground image against a single background color or against a background image. In case useBitmapBackground is false and applicationBackground and bitmapBackGround are null, a checkerboard will be used as background.

Parameters

useBitmapBackground	When true the background of this instance is used if it contains one.
applicationBackground	Backgroundcolor used in case useBitmapBackground is false and applicationBackground is not null.
bitmapBackGround	Background used in case useBitmapBackground is false and applicationBackground is a null reference.

Returns

Returns true on success, false on failure.

Definition at line 3493 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.ConvertColorDepth

(

FREE_IMAGE_COLOR_DEPTH

bpp

)

Converts this FreeImageBitmap into a different color depth. The parameter bpp specifies color depth, greyscale conversion and palette reorder.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_FORCE_GREYSCALE flag will first perform a convesion to greyscale. This can be done with any target color depth.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_REORDER_PALETTE flag will allow the algorithm to reorder the palette. This operation will not be performed to non-greyscale images to prevent data loss by mistake.

Parameters

bpp	A bitfield containing information about the conversion to perform.

Returns

Returns true on success, false on failure.

Definition at line 2732 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.ConvertColorDepth

(

FREE_IMAGE_COLOR_DEPTH

bpp

)

Converts this FreeImageBitmap into a different color depth. The parameter bpp specifies color depth, greyscale conversion and palette reorder.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_FORCE_GREYSCALE flag will first perform a convesion to greyscale. This can be done with any target color depth.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_REORDER_PALETTE flag will allow the algorithm to reorder the palette. This operation will not be performed to non-greyscale images to prevent data loss by mistake.

Parameters

bpp	A bitfield containing information about the conversion to perform.

Returns

Returns true on success, false on failure.

Definition at line 2732 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.ConvertType	(	FREE_IMAGE_TYPE	type,
		bool	scaleLinear
	)

Converts this FreeImageBitmap FREE_IMAGE_TYPE to type initializing a new instance. In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event.

Parameters

type	Destination type.
scaleLinear	True to scale linear, else false.

Returns

Returns true on success, false on failure.

Definition at line 2747 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ImageType.

bool FreeImageAPI.FreeImageBitmap.ConvertType	(	FREE_IMAGE_TYPE	type,
		bool	scaleLinear
	)

Converts this FreeImageBitmap FREE_IMAGE_TYPE to type initializing a new instance. In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event.

Parameters

type	Destination type.
scaleLinear	True to scale linear, else false.

Returns

Returns true on success, false on failure.

Definition at line 2747 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ImageType.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.Copy

(

Rectangle

rect

)

Copy a sub part of this FreeImageBitmap.

Parameters

rect	The subpart to copy.

Returns

The sub part in a new instance.

Definition at line 3419 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.Copy().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.Copy

(

Rectangle

rect

)

Copy a sub part of this FreeImageBitmap.

Parameters

rect	The subpart to copy.

Returns

The sub part in a new instance.

Definition at line 3419 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Copy().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.Copy	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

Copy a sub part of this FreeImageBitmap.

Parameters

left	Specifies the left position of the cropped rectangle.
top	Specifies the top position of the cropped rectangle.
right	Specifies the right position of the cropped rectangle.
bottom	Specifies the bottom position of the cropped rectangle.

Returns

The sub part in a new instance.

Definition at line 3433 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.Copy	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

Copy a sub part of this FreeImageBitmap.

Parameters

left	Specifies the left position of the cropped rectangle.
top	Specifies the top position of the cropped rectangle.
right	Specifies the right position of the cropped rectangle.
bottom	Specifies the bottom position of the cropped rectangle.

Returns

The sub part in a new instance.

Definition at line 3433 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FIICCPROFILE FreeImageAPI.FreeImageBitmap.CreateICCProfile

(

byte[]

data

)

Creates a new ICC-Profile.

Parameters

data	The data of the new ICC-Profile.

Returns

The new ICC-Profile of the bitmap.

Exceptions

ArgumentNullException

data is a null reference.

Definition at line 3677 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.CreateICCProfile().

FIICCPROFILE FreeImageAPI.FreeImageBitmap.CreateICCProfile

(

byte[]

data

)

Creates a new ICC-Profile.

Parameters

data	The data of the new ICC-Profile.

Returns

The new ICC-Profile of the bitmap.

Exceptions

ArgumentNullException

data is a null reference.

Definition at line 3679 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.CreateICCProfile().

FIICCPROFILE FreeImageAPI.FreeImageBitmap.CreateICCProfile	(	byte[]	data,
		int	size
	)

Creates a new ICC-Profile.

Parameters

data	The data of the new ICC-Profile.
size	The number of bytes of data to use.

Returns

The new ICC-Profile of the bitmap.

Exceptions

ArgumentNullException

data is null.

Definition at line 3693 of file FreeImageBitmap.cs.

References DirectX.size.

FIICCPROFILE FreeImageAPI.FreeImageBitmap.CreateICCProfile	(	byte[]	data,
		int	size
	)

Creates a new ICC-Profile.

Parameters

data	The data of the new ICC-Profile.
size	The number of bytes of data to use.

Returns

The new ICC-Profile of the bitmap.

Exceptions

ArgumentNullException

data is null.

Definition at line 3695 of file FreeImageBitmap.cs.

References DirectX.size.

static PropertyItem FreeImageAPI.FreeImageBitmap.CreateNewPropertyItem ( )

static

Returns a new instance of the PropertyItem class which has no public accessible constructor.

Returns

A new instace of PropertyItem.

Definition at line 4159 of file FreeImageBitmap.cs.

static PropertyItem FreeImageAPI.FreeImageBitmap.CreateNewPropertyItem ( )

static

Returns a new instance of the PropertyItem class which has no public accessible constructor.

Returns

A new instace of PropertyItem.

Definition at line 4161 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.Dispose

(

)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Definition at line 4307 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.Dispose().

void FreeImageAPI.FreeImageBitmap.Dispose

(

)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Definition at line 4309 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Dispose().

virtual void FreeImageAPI.FreeImageBitmap.Dispose ( bool  disposing )

protectedvirtual

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Parameters

disposing

If true managed ressources are released.

Definition at line 4318 of file FreeImageBitmap.cs.

virtual void FreeImageAPI.FreeImageBitmap.Dispose ( bool  disposing )

protectedvirtual

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Parameters

disposing

If true managed ressources are released.

Definition at line 4320 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.EnlargeCanvas< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 2882 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.EnlargeCanvas< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 2882 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.EnlargeCanvas< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color,
		FREE_IMAGE_COLOR_OPTIONS	options
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.
options	Options that affect the color search process for palletized images.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 2904 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.EnlargeCanvas< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color,
		FREE_IMAGE_COLOR_OPTIONS	options
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.
options	Options that affect the color search process for palletized images.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 2904 of file FreeImageBitmap.cs.

override bool FreeImageAPI.FreeImageBitmap.Equals

(

object

obj

)

Determines whether this and the specified instances are the same.

Parameters

obj	The object to test.

Returns

true if this instance is the same obj or if both are null references; otherwise, false.

Definition at line 3709 of file FreeImageBitmap.cs.

override bool FreeImageAPI.FreeImageBitmap.Equals

(

object

obj

)

Determines whether this and the specified instances are the same.

Parameters

obj	The object to test.

Returns

true if this instance is the same obj or if both are null references; otherwise, false.

Definition at line 3711 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.FillBackground< T >

(

T

color

)

Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

color

The color to fill this FreeImageBitmap with.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 3652 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.FillBackground< T >

(

T

color

)

Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

color

The color to fill this FreeImageBitmap with.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 3654 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.FillBackground< T >	(	T	color,
		FREE_IMAGE_COLOR_OPTIONS	options
	)

Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

color	The color to fill this FreeImageBitmap with.
options	Options that affect the color search process for palletized images.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 3665 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.FillBackground< T >	(	T	color,
		FREE_IMAGE_COLOR_OPTIONS	options
	)

Sets all pixels of this FreeImageBitmap to the specified color. See FreeImage.FillBackground&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

color	The color to fill this FreeImageBitmap with.
options	Options that affect the color search process for palletized images.

Returns

true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 3667 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.FreeHbitmap ( IntPtr  hbitmap )

static

Frees a bitmap handle.

Parameters

hbitmap

Handle to a bitmap.

Returns

true on success, false on failure.

Definition at line 3841 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.FreeHbitmap ( IntPtr  hbitmap )

static

Frees a bitmap handle.

Parameters

hbitmap

Handle to a bitmap.

Returns

true on success, false on failure.

Definition at line 3843 of file FreeImageBitmap.cs.

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromFile ( string  filename )

static

Creates a FreeImageBitmap from the specified file.

Parameters

filename

A string that contains the name of the file from which to create the FreeImageBitmap.

Returns

The FreeImageBitmap this method creates.

Definition at line 3791 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromFile ( string  filename )

static

Creates a FreeImageBitmap from the specified file.

Parameters

filename

A string that contains the name of the file from which to create the FreeImageBitmap.

Returns

The FreeImageBitmap this method creates.

Definition at line 3793 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromFile ( string  filename, bool  useEmbeddedColorManagement  )

static

Creates a FreeImageBitmap from the specified file using embedded color management information in that file.

Parameters

filename	A string that contains the name of the file from which to create the FreeImageBitmap.
useEmbeddedColorManagement	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3804 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromFile ( string  filename, bool  useEmbeddedColorManagement  )

static

Creates a FreeImageBitmap from the specified file using embedded color management information in that file.

Parameters

filename	A string that contains the name of the file from which to create the FreeImageBitmap.
useEmbeddedColorManagement	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3806 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromHbitmap ( IntPtr  hbitmap )

static

Creates a FreeImageBitmap from a handle to a GDI bitmap.

Parameters

hbitmap

The GDI bitmap handle from which to create the FreeImageBitmap.

Returns

The FreeImageBitmap this method creates.

Definition at line 3814 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

Referenced by FreeImageAPI.FreeImageBitmap.FromHbitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromHbitmap ( IntPtr  hbitmap )

static

Creates a FreeImageBitmap from a handle to a GDI bitmap.

Parameters

hbitmap

The GDI bitmap handle from which to create the FreeImageBitmap.

Returns

The FreeImageBitmap this method creates.

Definition at line 3816 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromHbitmap ( IntPtr  hbitmap, IntPtr  hpalette  )

static

Creates a FreeImageBitmap from a handle to a GDI bitmap and a handle to a GDI palette.

Parameters

hbitmap	The GDI bitmap handle from which to create the FreeImageBitmap.
hpalette	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3831 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FromHbitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromHbitmap ( IntPtr  hbitmap, IntPtr  hpalette  )

static

Creates a FreeImageBitmap from a handle to a GDI bitmap and a handle to a GDI palette.

Parameters

hbitmap	The GDI bitmap handle from which to create the FreeImageBitmap.
hpalette	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3833 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FromHbitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromHicon ( IntPtr  hicon )

static

Creates a FreeImageBitmap from a Windows handle to an icon.

Parameters

hicon

A handle to an icon.

Returns

The FreeImageBitmap that this method creates.

Definition at line 3762 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromHicon ( IntPtr  hicon )

static

Creates a FreeImageBitmap from a Windows handle to an icon.

Parameters

hicon

A handle to an icon.

Returns

The FreeImageBitmap that this method creates.

Definition at line 3764 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromResource ( IntPtr  hinstance, string  bitmapName  )

static

Creates a FreeImageBitmap from the specified Windows resource.

Parameters

hinstance	A handle to an instance of the executable file that contains the resource.
bitmapName	A string containing the name of the resource bitmap.

Returns

The FreeImageBitmap that this method creates.

Definition at line 3777 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromResource ( IntPtr  hinstance, string  bitmapName  )

static

Creates a FreeImageBitmap from the specified Windows resource.

Parameters

hinstance	A handle to an instance of the executable file that contains the resource.
bitmapName	A string containing the name of the resource bitmap.

Returns

The FreeImageBitmap that this method creates.

Definition at line 3779 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromStream ( Stream  stream )

static

Creates a FreeImageBitmap from the specified data stream.

Parameters

stream

A Stream that contains the data for this FreeImageBitmap.

Returns

The FreeImageBitmap this method creates.

Definition at line 3851 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromStream ( Stream  stream )

static

Creates a FreeImageBitmap from the specified data stream.

Parameters

stream

A Stream that contains the data for this FreeImageBitmap.

Returns

The FreeImageBitmap this method creates.

Definition at line 3853 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromStream ( Stream  stream, bool  useEmbeddedColorManagement  )

static

Creates a FreeImageBitmap from the specified data stream.

Parameters

stream	A Stream that contains the data for this FreeImageBitmap.
useEmbeddedColorManagement	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3862 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromStream ( Stream  stream, bool  useEmbeddedColorManagement  )

static

Creates a FreeImageBitmap from the specified data stream.

Parameters

stream	A Stream that contains the data for this FreeImageBitmap.
useEmbeddedColorManagement	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3864 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromStream ( Stream  stream, bool  useEmbeddedColorManagement, bool  validateImageData  )

static

Creates a FreeImageBitmap from the specified data stream.

Parameters

stream	A Stream that contains the data for this FreeImageBitmap.
useEmbeddedColorManagement	Ignored.
validateImageData	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3874 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageBitmap FreeImageAPI.FreeImageBitmap.FromStream ( Stream  stream, bool  useEmbeddedColorManagement, bool  validateImageData  )

static

Creates a FreeImageBitmap from the specified data stream.

Parameters

stream	A Stream that contains the data for this FreeImageBitmap.
useEmbeddedColorManagement	Ignored.
validateImageData	Ignored.

Returns

The FreeImageBitmap this method creates.

Definition at line 3876 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static int FreeImageAPI.FreeImageBitmap.GetAdjustColorsLookupTable ( byte[]  lookUpTable, double  brightness, double  contrast, double  gamma, bool  invert  )

static

Creates a lookup table to be used with AdjustCurve() which may adjusts brightness and contrast, correct gamma and invert the image with a single call to AdjustCurve().

Parameters

lookUpTable	Output lookup table to be used with AdjustCurve(). The size of lookUpTable is assumed to be 256.
brightness	Percentage brightness value where -100 <= brightness <= 100.

A value of 0 means no change, less than 0 will make the image darker and greater than 0 will make the image brighter.

Parameters

contrast

Percentage contrast value where -100 <= contrast <= 100.

A value of 0 means no change, less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image.

Parameters

gamma

Gamma value to be used for gamma correction.

A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it.

Parameters

invert

If set to true, the image will be inverted.

Returns

The number of adjustments applied to the resulting lookup table compared to a blind lookup table.

Exceptions

ArgumentNullException	lookUpTable is null.
ArgumentException	lookUpTable is not 256.

Definition at line 4024 of file FreeImageBitmap.cs.

static int FreeImageAPI.FreeImageBitmap.GetAdjustColorsLookupTable ( byte[]  lookUpTable, double  brightness, double  contrast, double  gamma, bool  invert  )

static

Creates a lookup table to be used with AdjustCurve() which may adjusts brightness and contrast, correct gamma and invert the image with a single call to AdjustCurve().

Parameters

lookUpTable	Output lookup table to be used with AdjustCurve(). The size of lookUpTable is assumed to be 256.
brightness	Percentage brightness value where -100 <= brightness <= 100.

A value of 0 means no change, less than 0 will make the image darker and greater than 0 will make the image brighter.

Parameters

contrast

Percentage contrast value where -100 <= contrast <= 100.

A value of 0 means no change, less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image.

Parameters

gamma

Gamma value to be used for gamma correction.

A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it.

Parameters

invert

If set to true, the image will be inverted.

Returns

The number of adjustments applied to the resulting lookup table compared to a blind lookup table.

Exceptions

ArgumentNullException	lookUpTable is null.
ArgumentException	lookUpTable.Length is not 256.

Definition at line 4026 of file FreeImageBitmap.cs.

RectangleF FreeImageAPI.FreeImageBitmap.GetBounds

(

ref GraphicsUnit

pageUnit

)

Gets the bounds of this FreeImageBitmap in the specified unit.

Parameters

pageUnit

One of the System.Drawing.GraphicsUnit values indicating the unit of measure for the bounding rectangle.

Returns

The System.Drawing.RectangleF that represents the bounds of this FreeImageBitmap, in the specified unit.

Definition at line 1729 of file FreeImageBitmap.cs.

RectangleF FreeImageAPI.FreeImageBitmap.GetBounds

(

ref GraphicsUnit

pageUnit

)

Gets the bounds of this FreeImageBitmap in the specified unit.

Parameters

pageUnit

One of the System.Drawing.GraphicsUnit values indicating the unit of measure for the bounding rectangle.

Returns

The System.Drawing.RectangleF that represents the bounds of this FreeImageBitmap, in the specified unit.

Definition at line 1729 of file FreeImageBitmap.cs.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetChannel

(

FREE_IMAGE_COLOR_CHANNEL

channel

)

Retrieves the red, green, blue or alpha channel of a 24- or 32-bit image.

Parameters

channel

The color channel to extract.

Returns

The color channel in a new instance.

Definition at line 3357 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetChannel

(

FREE_IMAGE_COLOR_CHANNEL

channel

)

Retrieves the red, green, blue or alpha channel of a 24- or 32-bit image.

Parameters

channel

The color channel to extract.

Returns

The color channel in a new instance.

Definition at line 3357 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetColorConvertedInstance

(

FREE_IMAGE_COLOR_DEPTH

bpp

)

Converts this FreeImageBitmap into a different color depth initializing a new instance. The parameter bpp specifies color depth, greyscale conversion and palette reorder.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_FORCE_GREYSCALE flag will first perform a convesion to greyscale. This can be done with any target color depth.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_REORDER_PALETTE flag will allow the algorithm to reorder the palette. This operation will not be performed to non-greyscale images to prevent data loss by mistake.

Parameters

bpp	A bitfield containing information about the conversion to perform.

Returns

The converted instance.

Definition at line 2790 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetColorConvertedInstance

(

FREE_IMAGE_COLOR_DEPTH

bpp

)

Converts this FreeImageBitmap into a different color depth initializing a new instance. The parameter bpp specifies color depth, greyscale conversion and palette reorder.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_FORCE_GREYSCALE flag will first perform a convesion to greyscale. This can be done with any target color depth.

Adding the FREE_IMAGE_COLOR_DEPTH.FICD_REORDER_PALETTE flag will allow the algorithm to reorder the palette. This operation will not be performed to non-greyscale images to prevent data loss by mistake.

Parameters

bpp	A bitfield containing information about the conversion to perform.

Returns

The converted instance.

Definition at line 2790 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetComplexChannel

(

FREE_IMAGE_COLOR_CHANNEL

channel

)

Retrieves the real part, imaginary part, magnitude or phase of a complex image.

Parameters

channel

The color channel to extract.

Returns

The color channel in a new instance.

Definition at line 3388 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetComplexChannel

(

FREE_IMAGE_COLOR_CHANNEL

channel

)

Retrieves the real part, imaginary part, magnitude or phase of a complex image.

Parameters

channel

The color channel to extract.

Returns

The color channel in a new instance.

Definition at line 3388 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetEnlargedInstance< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.

Returns

The enlarged instance.

Type Constraints

T

:

struct

Definition at line 2927 of file FreeImageBitmap.cs.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetEnlargedInstance< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.

Returns

The enlarged instance.

Type Constraints

T

:

struct

Definition at line 2927 of file FreeImageBitmap.cs.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetEnlargedInstance< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color,
		FREE_IMAGE_COLOR_OPTIONS	options
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.
options	Options that affect the color search process for palletized images.

Returns

The enlarged instance.

Type Constraints

T

:

struct

Definition at line 2950 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetEnlargedInstance< T >	(	int	left,
		int	top,
		int	right,
		int	bottom,
		T?	color,
		FREE_IMAGE_COLOR_OPTIONS	options
	)

Enlarges or shrinks this FreeImageBitmap selectively per side and fills newly added areas with the specified background color returning a new instance. See FreeImage.EnlargeCanvas&lt;T&gt; for further details.

Template Parameters

T	The type of the specified color.

Parameters

left	The number of pixels, the image should be enlarged on its left side. Negative values shrink the image on its left side.
top	The number of pixels, the image should be enlarged on its top side. Negative values shrink the image on its top side.
right	The number of pixels, the image should be enlarged on its right side. Negative values shrink the image on its right side.
bottom	The number of pixels, the image should be enlarged on its bottom side. Negative values shrink the image on its bottom side.
color	The color, the enlarged sides of the image should be filled with.
options	Options that affect the color search process for palletized images.

Returns

The enlarged instance.

Type Constraints

T

:

struct

Definition at line 2950 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

override int FreeImageAPI.FreeImageBitmap.GetHashCode

(

)

Returns a hash code for this FreeImageBitmap structure.

Returns

An integer value that specifies the hash code for this FreeImageBitmap.

Definition at line 3718 of file FreeImageBitmap.cs.

override int FreeImageAPI.FreeImageBitmap.GetHashCode

(

)

Returns a hash code for this FreeImageBitmap structure.

Returns

An integer value that specifies the hash code for this FreeImageBitmap.

Definition at line 3720 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetHbitmap

(

)

Creates a GDI bitmap object from this FreeImageBitmap.

Returns

A handle to the GDI bitmap object that this method creates.

Definition at line 2527 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetHbitmap

(

)

Creates a GDI bitmap object from this FreeImageBitmap.

Returns

A handle to the GDI bitmap object that this method creates.

Definition at line 2527 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetHbitmap

(

Color

background

)

Creates a GDI bitmap object from this FreeImageBitmap.

Parameters

background

A System.Drawing.Color structure that specifies the background color. This parameter is ignored if the bitmap is totally opaque.

Returns

A handle to the GDI bitmap object that this method creates.

Definition at line 2539 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

IntPtr FreeImageAPI.FreeImageBitmap.GetHbitmap

(

Color

background

)

Creates a GDI bitmap object from this FreeImageBitmap.

Parameters

background

A System.Drawing.Color structure that specifies the background color. This parameter is ignored if the bitmap is totally opaque.

Returns

A handle to the GDI bitmap object that this method creates.

Definition at line 2539 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

IntPtr FreeImageAPI.FreeImageBitmap.GetHbitmapForDevice

(

)

Creates a GDI bitmap object from this FreeImageBitmap with the same color depth as the primary device.

Returns

A handle to the GDI bitmap object that this method creates.

Definition at line 2567 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetHbitmapForDevice

(

)

Creates a GDI bitmap object from this FreeImageBitmap with the same color depth as the primary device.

Returns

A handle to the GDI bitmap object that this method creates.

Definition at line 2567 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetHicon

(

)

Returns the handle to an icon.

Returns

A Windows handle to an icon with the same image as this FreeImageBitmap.

Definition at line 2553 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetHicon

(

)

Returns the handle to an icon.

Returns

A Windows handle to an icon with the same image as this FreeImageBitmap.

Definition at line 2553 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.GetHistogram	(	FREE_IMAGE_COLOR_CHANNEL	channel,
		out int[]	histogram
	)

Computes the image histogram.

Parameters

channel	Channel to compute from.
histogram	Array of integers containing the histogram.

Returns

Returns true on success, false on failure.

Definition at line 3345 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.GetHistogram	(	FREE_IMAGE_COLOR_CHANNEL	channel,
		out int[]	histogram
	)

Computes the image histogram.

Parameters

channel	Channel to compute from.
histogram	Array of integers containing the histogram.

Returns

Returns true on success, false on failure.

Definition at line 3345 of file FreeImageBitmap.cs.

unsafe Color FreeImageAPI.FreeImageBitmap.GetPixel	(	int	x,
		int	y
	)

Gets the Color of the specified pixel in this FreeImageBitmap.

Parameters

x	The x-coordinate of the pixel to retrieve.
y	The y-coordinate of the pixel to retrieve.

Returns

A System.Drawing.Color structure that represents the color of the specified pixel.

Exceptions

Exception	The operation failed.
NotSupportedException	The type of this bitmap is not supported.

Definition at line 2581 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

unsafe Color FreeImageAPI.FreeImageBitmap.GetPixel	(	int	x,
		int	y
	)

Gets the Color of the specified pixel in this FreeImageBitmap.

Parameters

x	The x-coordinate of the pixel to retrieve.
y	The y-coordinate of the pixel to retrieve.

Returns

A System.Drawing.Color structure that represents the color of the specified pixel.

Exceptions

Exception	The operation failed.
NotSupportedException	The type of this bitmap is not supported.

Definition at line 2581 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

static int FreeImageAPI.FreeImageBitmap.GetPixelFormatSize ( PixelFormat  pixfmt )

static

Returns the color depth, in number of bits per pixel, of the specified pixel format.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat member that specifies the format for which to find the size.

Returns

The color depth of the specified pixel format.

Definition at line 3886 of file FreeImageBitmap.cs.

static int FreeImageAPI.FreeImageBitmap.GetPixelFormatSize ( PixelFormat  pixfmt )

static

Returns the color depth, in number of bits per pixel, of the specified pixel format.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat member that specifies the format for which to find the size.

Returns

The color depth of the specified pixel format.

Definition at line 3888 of file FreeImageBitmap.cs.

PropertyItem FreeImageAPI.FreeImageBitmap.GetPropertyItem

(

int

propid

)

Gets the specified property item from this FreeImageBitmap.

Parameters

propid

The ID of the property item to get.

Returns

The PropertyItem this method gets.

Definition at line 1745 of file FreeImageBitmap.cs.

References FreeImageAPI.Metadata.MetadataTag.ID, and DirectX.metadata.

PropertyItem FreeImageAPI.FreeImageBitmap.GetPropertyItem

(

int

propid

)

Gets the specified property item from this FreeImageBitmap.

Parameters

propid

The ID of the property item to get.

Returns

The PropertyItem this method gets.

Definition at line 1745 of file FreeImageBitmap.cs.

References FreeImageAPI.Metadata.MetadataTag.ID, and DirectX.metadata.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.

Returns

The quantized instance.

Definition at line 3035 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.GetQuantizedInstance().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.

Returns

The quantized instance.

Definition at line 3035 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.GetQuantizedInstance().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and reservePalette palette initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reservePalette	The provided palette.

Returns

The quantized instance.

Definition at line 3049 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.GetQuantizedInstance(), and FreeImageAPI.MemoryArray< T >.Length.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and reservePalette palette initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reservePalette	The provided palette.

Returns

The quantized instance.

Definition at line 3049 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.GetQuantizedInstance(), and FreeImageAPI.MemoryArray< T >.Length.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette.
reservePalette	The provided palette.

Returns

The quantized instance.

Definition at line 3065 of file FreeImageBitmap.cs.

References FreeImageAPI.MemoryArray< T >.Data, and FreeImageAPI.FreeImageBitmap.GetQuantizedInstance().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette.
reservePalette	The provided palette.

Returns

The quantized instance.

Definition at line 3065 of file FreeImageBitmap.cs.

References FreeImageAPI.MemoryArray< T >.Data, and FreeImageAPI.FreeImageBitmap.GetQuantizedInstance().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		RGBQUAD[]	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette.
reservePalette	The provided palette.

Returns

The quantized instance.

Definition at line 3081 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetQuantizedInstance	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		RGBQUAD[]	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit, using the specified algorithm and up to reserveSize entries from reservePalette palette initializing a new 8 bit instance with the specified paletteSize .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette.
reservePalette	The provided palette.

Returns

The quantized instance.

Definition at line 3081 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetRotatedInstance

(

double

angle

)

Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Parameters

angle

The angle of rotation.

Returns

The rotated instance.

Definition at line 3215 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth, FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetRotatedInstance

(

double

angle

)

Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Parameters

angle

The angle of rotation.

Returns

The rotated instance.

Definition at line 3215 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth, FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetRotatedInstance	(	double	angle,
		double	xShift,
		double	yShift,
		double	xOrigin,
		double	yOrigin,
		bool	useMask
	)

This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline initializing a new instance.

Parameters

angle	The angle of rotation.
xShift	Horizontal image translation.
yShift	Vertical image translation.
xOrigin	Rotation center x-coordinate.
yOrigin	Rotation center y-coordinate.
useMask	When true the irrelevant part of the image is set to a black color, otherwise, a mirroring technique is used to fill irrelevant pixels.

Returns

The rotated instance.

Definition at line 3266 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetRotatedInstance	(	double	angle,
		double	xShift,
		double	yShift,
		double	xOrigin,
		double	yOrigin,
		bool	useMask
	)

This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline initializing a new instance.

Parameters

angle	The angle of rotation.
xShift	Horizontal image translation.
yShift	Vertical image translation.
xOrigin	Rotation center x-coordinate.
yOrigin	Rotation center y-coordinate.
useMask	When true the irrelevant part of the image is set to a black color, otherwise, a mirroring technique is used to fill irrelevant pixels.

Returns

The rotated instance.

Definition at line 3266 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetRotatedInstance< T >	(	double	angle,
		T?	backgroundColor
	)

Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Template Parameters

T	The type of the color to use as background.

Parameters

angle	The angle of rotation.
backgroundColor	The color used used to fill the bitmap's background.

Returns

The rotated instance.

Type Constraints

T

:

struct

Definition at line 3188 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth, FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetRotatedInstance< T >	(	double	angle,
		T?	backgroundColor
	)

Rotates this FreeImageBitmap by the specified angle initializing a new instance. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Template Parameters

T	The type of the color to use as background.

Parameters

angle	The angle of rotation.
backgroundColor	The color used used to fill the bitmap's background.

Returns

The rotated instance.

Type Constraints

T

:

struct

Definition at line 3188 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth, FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetScaledInstance	(	Size	newSize,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance.

Parameters

newSize	The Size structure that represent the size of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

The rescaled instance.

Definition at line 2841 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.GetScaledInstance().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetScaledInstance	(	Size	newSize,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance.

Parameters

newSize	The Size structure that represent the size of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

The rescaled instance.

Definition at line 2841 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.GetScaledInstance().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetScaledInstance	(	int	width,
		int	height,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance.

Parameters

width	Width of the new FreeImageBitmap.
height	Height of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

The rescaled instance.

Definition at line 2854 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetScaledInstance	(	int	width,
		int	height,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter initializing a new instance.

Parameters

width	Width of the new FreeImageBitmap.
height	Height of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

The rescaled instance.

Definition at line 2854 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

object FreeImageAPI.FreeImageBitmap.GetScanline

(

int

scanline

)

Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image.

Parameters

scanline

Number of the scanline to retrieve.

Returns

An instance of Scanline&lt;T&gt; representing the scanline th scanline.

List of return-types of T:

Color Depth / Type	Result Type
1 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI1BIT
4 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI4BIT
8 (FREE_IMAGE_TYPE.FIT_BITMAP)	Byte
16 (FREE_IMAGE_TYPE.FIT_BITMAP)	UInt16
16 - 555 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB555
16 - 565 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB565
24 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBTRIPLE
32 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBQUAD
FREE_IMAGE_TYPE.FIT_COMPLEX	FICOMPLEX
FREE_IMAGE_TYPE.FIT_DOUBLE	Double
FREE_IMAGE_TYPE.FIT_FLOAT	Single
FREE_IMAGE_TYPE.FIT_INT16	Int16
FREE_IMAGE_TYPE.FIT_INT32	Int32
FREE_IMAGE_TYPE.FIT_RGB16	FIRGB16
FREE_IMAGE_TYPE.FIT_RGBA16	FIRGBA16
FREE_IMAGE_TYPE.FIT_RGBAF	FIRGBAF
FREE_IMAGE_TYPE.FIT_RGBF	FIRGBF
FREE_IMAGE_TYPE.FIT_UINT16	UInt16
FREE_IMAGE_TYPE.FIT_UINT32	UInt32

FreeImageBitmap bitmap = new FreeImageBitmap(@"C:\Pictures\picture.bmp");
if (bitmap.ColorDepth == 32)
{
    Scanline<RGBQUAD> scanline = (Scanline<RGBQUAD>)bitmap.GetScanline(0);
    foreach (RGBQUAD pixel in scanline)
    {
        Log.Info(pixel);
    }
}

Exceptions

ArgumentException	The type of the bitmap or color depth are not supported.
ArgumentOutOfRangeException	scanline is no valid value.

Definition at line 1927 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.BlueMask, FreeImageAPI.FreeImageBitmap.GreenMask, and FreeImageAPI.FreeImageBitmap.RedMask.

Referenced by FreeImageAPI.FreeImageBitmap.GetScanlines().

object FreeImageAPI.FreeImageBitmap.GetScanline

(

int

scanline

)

Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image.

Parameters

scanline

Number of the scanline to retrieve.

Returns

An instance of Scanline&lt;T&gt; representing the scanline th scanline.

List of return-types of T:

Color Depth / Type	Result Type
1 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI1BIT
4 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI4BIT
8 (FREE_IMAGE_TYPE.FIT_BITMAP)	Byte
16 (FREE_IMAGE_TYPE.FIT_BITMAP)	UInt16
16 - 555 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB555
16 - 565 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB565
24 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBTRIPLE
32 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBQUAD
FREE_IMAGE_TYPE.FIT_COMPLEX	FICOMPLEX
FREE_IMAGE_TYPE.FIT_DOUBLE	Double
FREE_IMAGE_TYPE.FIT_FLOAT	Single
FREE_IMAGE_TYPE.FIT_INT16	Int16
FREE_IMAGE_TYPE.FIT_INT32	Int32
FREE_IMAGE_TYPE.FIT_RGB16	FIRGB16
FREE_IMAGE_TYPE.FIT_RGBA16	FIRGBA16
FREE_IMAGE_TYPE.FIT_RGBAF	FIRGBAF
FREE_IMAGE_TYPE.FIT_RGBF	FIRGBF
FREE_IMAGE_TYPE.FIT_UINT16	UInt16
FREE_IMAGE_TYPE.FIT_UINT32	UInt32

FreeImageBitmap bitmap = new FreeImageBitmap(@"C:\Pictures\picture.bmp");
if (bitmap.ColorDepth == 32)
{
    Scanline<RGBQUAD> scanline = (Scanline<RGBQUAD>)bitmap.GetScanline(0);
    foreach (RGBQUAD pixel in scanline)
    {
        Console.WriteLine(pixel);
    }
}

Exceptions

ArgumentException	The type of the bitmap or color depth are not supported.
ArgumentOutOfRangeException	scanline is no valid value.

Definition at line 1927 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.BlueMask, FreeImageAPI.FreeImageBitmap.GreenMask, and FreeImageAPI.FreeImageBitmap.RedMask.

Scanline<T> FreeImageAPI.FreeImageBitmap.GetScanline< T >

(

int

scanline

)

Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image.

Parameters

scanline

Number of the scanline to retrieve.

Returns

An instance of Scanline&lt;T&gt; representing the scanline th scanline.

List of return-types of T:

Color Depth / Type	Result Type
1 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI1BIT
4 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI4BIT
8 (FREE_IMAGE_TYPE.FIT_BITMAP)	Byte
16 (FREE_IMAGE_TYPE.FIT_BITMAP)	UInt16
16 - 555 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB555
16 - 565 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB565
24 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBTRIPLE
32 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBQUAD
FREE_IMAGE_TYPE.FIT_COMPLEX	FICOMPLEX
FREE_IMAGE_TYPE.FIT_DOUBLE	Double
FREE_IMAGE_TYPE.FIT_FLOAT	Single
FREE_IMAGE_TYPE.FIT_INT16	Int16
FREE_IMAGE_TYPE.FIT_INT32	Int32
FREE_IMAGE_TYPE.FIT_RGB16	FIRGB16
FREE_IMAGE_TYPE.FIT_RGBA16	FIRGBA16
FREE_IMAGE_TYPE.FIT_RGBAF	FIRGBAF
FREE_IMAGE_TYPE.FIT_RGBF	FIRGBF
FREE_IMAGE_TYPE.FIT_UINT16	UInt16
FREE_IMAGE_TYPE.FIT_UINT32	UInt32

FreeImageBitmap bitmap = new FreeImageBitmap(@"C:\Pictures\picture.bmp");
if (bitmap.ColorDepth == 32)
{
    Scanline<RGBQUAD> scanline = bitmap.GetScanline<RGBQUAD>(0);
    foreach (RGBQUAD pixel in scanline)
    {
        Console.WriteLine(pixel);
    }
}

Exceptions

ArgumentException	The bitmap's type or color depth are not supported.
ArgumentOutOfRangeException	scanline is no valid value.

Type Constraints

T

:

struct

Definition at line 1868 of file FreeImageBitmap.cs.

Scanline<T> FreeImageAPI.FreeImageBitmap.GetScanline< T >

(

int

scanline

)

Returns an instance of Scanline&lt;T&gt;, representing the scanline specified by scanline of this FreeImageBitmap. Since FreeImage bitmaps are always bottum up aligned, keep in mind that scanline 0 is the bottom-most line of the image.

Parameters

scanline

Number of the scanline to retrieve.

Returns

An instance of Scanline&lt;T&gt; representing the scanline th scanline.

List of return-types of T:

Color Depth / Type	Result Type
1 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI1BIT
4 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI4BIT
8 (FREE_IMAGE_TYPE.FIT_BITMAP)	Byte
16 (FREE_IMAGE_TYPE.FIT_BITMAP)	UInt16
16 - 555 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB555
16 - 565 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB565
24 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBTRIPLE
32 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBQUAD
FREE_IMAGE_TYPE.FIT_COMPLEX	FICOMPLEX
FREE_IMAGE_TYPE.FIT_DOUBLE	Double
FREE_IMAGE_TYPE.FIT_FLOAT	Single
FREE_IMAGE_TYPE.FIT_INT16	Int16
FREE_IMAGE_TYPE.FIT_INT32	Int32
FREE_IMAGE_TYPE.FIT_RGB16	FIRGB16
FREE_IMAGE_TYPE.FIT_RGBA16	FIRGBA16
FREE_IMAGE_TYPE.FIT_RGBAF	FIRGBAF
FREE_IMAGE_TYPE.FIT_RGBF	FIRGBF
FREE_IMAGE_TYPE.FIT_UINT16	UInt16
FREE_IMAGE_TYPE.FIT_UINT32	UInt32

FreeImageBitmap bitmap = new FreeImageBitmap(@"C:\Pictures\picture.bmp");
if (bitmap.ColorDepth == 32)
{
    Scanline<RGBQUAD> scanline = bitmap.GetScanline<RGBQUAD>(0);
    foreach (RGBQUAD pixel in scanline)
    {
        Log.Info(pixel);
    }
}

Exceptions

ArgumentException	The bitmap's type or color depth are not supported.
ArgumentOutOfRangeException	scanline is no valid value.

Type Constraints

T

:

struct

Definition at line 1868 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetScanlinePointer

(

int

scanline

)

Returns a pointer to the specified scanline. Due to FreeImage bitmaps are bottum up, scanline 0 is the most bottom line of the image.

Parameters

scanline

Number of the scanline.

Returns

Pointer to the scanline.

Definition at line 1991 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.GetScanlinePointer

(

int

scanline

)

Returns a pointer to the specified scanline. Due to FreeImage bitmaps are bottum up, scanline 0 is the most bottom line of the image.

Parameters

scanline

Number of the scanline.

Returns

Pointer to the scanline.

Definition at line 1991 of file FreeImageBitmap.cs.

IList FreeImageAPI.FreeImageBitmap.GetScanlines

(

)

Returns a list of structures, representing the scanlines of this FreeImageBitmap. Due to FreeImage bitmaps are bottum up, scanline 0 is the bottom-most line of the image. Each color depth has a different representing structure due to different memory layouts.

List of return-types of T:

Color Depth / Type	Result Type of IEnmuerable<Scanline<T>>
1 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI1BIT
4 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI4BIT
8 (FREE_IMAGE_TYPE.FIT_BITMAP)	Byte
16 (FREE_IMAGE_TYPE.FIT_BITMAP)	UInt16
16 - 555 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB555
16 - 565 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB565
24 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBTRIPLE
32 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBQUAD
FREE_IMAGE_TYPE.FIT_COMPLEX	FICOMPLEX
FREE_IMAGE_TYPE.FIT_DOUBLE	Double
FREE_IMAGE_TYPE.FIT_FLOAT	Single
FREE_IMAGE_TYPE.FIT_INT16	Int16
FREE_IMAGE_TYPE.FIT_INT32	Int32
FREE_IMAGE_TYPE.FIT_RGB16	FIRGB16
FREE_IMAGE_TYPE.FIT_RGBA16	FIRGBA16
FREE_IMAGE_TYPE.FIT_RGBAF	FIRGBAF
FREE_IMAGE_TYPE.FIT_RGBF	FIRGBF
FREE_IMAGE_TYPE.FIT_UINT16	UInt16
FREE_IMAGE_TYPE.FIT_UINT32	UInt32

Definition at line 2028 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.GetScanline().

IList FreeImageAPI.FreeImageBitmap.GetScanlines

(

)

Returns a list of structures, representing the scanlines of this FreeImageBitmap. Due to FreeImage bitmaps are bottum up, scanline 0 is the bottom-most line of the image. Each color depth has a different representing structure due to different memory layouts.

List of return-types of T:

Color Depth / Type	Result Type of IEnmuerable<Scanline<T>>
1 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI1BIT
4 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI4BIT
8 (FREE_IMAGE_TYPE.FIT_BITMAP)	Byte
16 (FREE_IMAGE_TYPE.FIT_BITMAP)	UInt16
16 - 555 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB555
16 - 565 (FREE_IMAGE_TYPE.FIT_BITMAP)	FI16RGB565
24 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBTRIPLE
32 (FREE_IMAGE_TYPE.FIT_BITMAP)	RGBQUAD
FREE_IMAGE_TYPE.FIT_COMPLEX	FICOMPLEX
FREE_IMAGE_TYPE.FIT_DOUBLE	Double
FREE_IMAGE_TYPE.FIT_FLOAT	Single
FREE_IMAGE_TYPE.FIT_INT16	Int16
FREE_IMAGE_TYPE.FIT_INT32	Int32
FREE_IMAGE_TYPE.FIT_RGB16	FIRGB16
FREE_IMAGE_TYPE.FIT_RGBA16	FIRGBA16
FREE_IMAGE_TYPE.FIT_RGBAF	FIRGBAF
FREE_IMAGE_TYPE.FIT_RGBF	FIRGBF
FREE_IMAGE_TYPE.FIT_UINT16	UInt16
FREE_IMAGE_TYPE.FIT_UINT32	UInt32

Definition at line 2028 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.GetScanline().

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetThumbnailImage	(	int	thumbWidth,
		int	thumbHeight,
		Image.GetThumbnailImageAbort	callback,
		IntPtr	callBackData
	)

Returns a thumbnail for this FreeImageBitmap.

Parameters

thumbWidth	The width, in pixels, of the requested thumbnail image.
thumbHeight	The height, in pixels, of the requested thumbnail image.
callback	Ignored.
callBackData	Ignored.

Returns

A FreeImageBitmap that represents the thumbnail.

Definition at line 1770 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetThumbnailImage	(	int	thumbWidth,
		int	thumbHeight,
		Image.GetThumbnailImageAbort	callback,
		IntPtr	callBackData
	)

Returns a thumbnail for this FreeImageBitmap.

Parameters

thumbWidth	The width, in pixels, of the requested thumbnail image.
thumbHeight	The height, in pixels, of the requested thumbnail image.
callback	Ignored.
callBackData	Ignored.

Returns

A FreeImageBitmap that represents the thumbnail.

Definition at line 1770 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetThumbnailImage	(	int	maxPixelSize,
		bool	convert
	)

Returns a thumbnail for this FreeImageBitmap, keeping aspect ratio. maxPixelSize defines the maximum width or height of the thumbnail.

Parameters

maxPixelSize	Thumbnail square size.
convert	When true HDR images are transperantly converted to standard images.

Returns

The thumbnail in a new instance.

Definition at line 1793 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetThumbnailImage	(	int	maxPixelSize,
		bool	convert
	)

Returns a thumbnail for this FreeImageBitmap, keeping aspect ratio. maxPixelSize defines the maximum width or height of the thumbnail.

Parameters

maxPixelSize	Thumbnail square size.
convert	When true HDR images are transperantly converted to standard images.

Returns

The thumbnail in a new instance.

Definition at line 1793 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetTypeConvertedInstance	(	FREE_IMAGE_TYPE	type,
		bool	scaleLinear
	)

Converts this FreeImageBitmap FreeImageBitmap to type . In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event.

Parameters

type	Destination type.
scaleLinear	True to scale linear, else false.

Returns

The converted instance.

Definition at line 2761 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), FreeImageAPI.FreeImageBitmap.ImageType, and FreeImageAPI.FIBITMAP.IsNull.

FreeImageBitmap FreeImageAPI.FreeImageBitmap.GetTypeConvertedInstance	(	FREE_IMAGE_TYPE	type,
		bool	scaleLinear
	)

Converts this FreeImageBitmap FreeImageBitmap to type . In case source and destination type are the same, the operation fails. An error message can be catched using the 'Message' event.

Parameters

type	Destination type.
scaleLinear	True to scale linear, else false.

Returns

The converted instance.

Definition at line 2761 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap(), FreeImageAPI.FreeImageBitmap.ImageType, and FreeImageAPI.FIBITMAP.IsNull.

bool FreeImageAPI.FreeImageBitmap.Invert

(

)

Inverts each pixel data.

Returns

Returns true on success, false on failure.

Definition at line 3333 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Invert

(

)

Inverts each pixel data.

Returns

Returns true on success, false on failure.

Definition at line 3333 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.IsAlphaPixelFormat ( PixelFormat  pixfmt )

static

Returns a value that indicates whether the pixel format for this FreeImageBitmap contains alpha information.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat to test.

Returns

true if pixfmt contains alpha information; otherwise, false.

Definition at line 3732 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.IsAlphaPixelFormat ( PixelFormat  pixfmt )

static

Returns a value that indicates whether the pixel format for this FreeImageBitmap contains alpha information.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat to test.

Returns

true if pixfmt contains alpha information; otherwise, false.

Definition at line 3734 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.IsCanonicalPixelFormat ( PixelFormat  pixfmt )

static

Returns a value that indicates whether the pixel format is 32 bits per pixel.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat to test.

Returns

true if pixfmt is canonical; otherwise, false.

Definition at line 3742 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.IsCanonicalPixelFormat ( PixelFormat  pixfmt )

static

Returns a value that indicates whether the pixel format is 32 bits per pixel.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat to test.

Returns

true if pixfmt is canonical; otherwise, false.

Definition at line 3744 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.IsExtendedPixelFormat ( PixelFormat  pixfmt )

static

Returns a value that indicates whether the pixel format is 64 bits per pixel.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat enumeration to test.

Returns

true if pixfmt is extended; otherwise, false.

Definition at line 3752 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.IsExtendedPixelFormat ( PixelFormat  pixfmt )

static

Returns a value that indicates whether the pixel format is 64 bits per pixel.

Parameters

pixfmt

The System.Drawing.Imaging.PixelFormat enumeration to test.

Returns

true if pixfmt is extended; otherwise, false.

Definition at line 3754 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.JPEGCrop ( string  source, string  destination, Rectangle  rect  )

static

Performs a lossless crop on a JPEG file.

Parameters

source	Source filename.
destination	Destination filename.
rect	Specifies the cropped rectangle.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException	source or destination is null.
FileNotFoundException	source does not exist.

Definition at line 3917 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.JPEGCrop().

static bool FreeImageAPI.FreeImageBitmap.JPEGCrop ( string  source, string  destination, Rectangle  rect  )

static

Performs a lossless crop on a JPEG file.

Parameters

source	Source filename.
destination	Destination filename.
rect	Specifies the cropped rectangle.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException	source or destination is null.
FileNotFoundException	source does not exist.

Definition at line 3919 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.JPEGCrop().

static bool FreeImageAPI.FreeImageBitmap.JPEGCrop ( string  source, string  destination, int  left, int  top, int  right, int  bottom  )

static

Performs a lossless crop on a JPEG file.

Parameters

source	Source filename.
destination	Destination filename.
left	Specifies the left position of the cropped rectangle.
top	Specifies the top position of the cropped rectangle.
right	Specifies the right position of the cropped rectangle.
bottom	Specifies the bottom position of the cropped rectangle.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException	source or destination is null.
FileNotFoundException	source does not exist.

Definition at line 3950 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.JPEGCrop ( string  source, string  destination, int  left, int  top, int  right, int  bottom  )

static

Performs a lossless crop on a JPEG file.

Parameters

source	Source filename.
destination	Destination filename.
left	Specifies the left position of the cropped rectangle.
top	Specifies the top position of the cropped rectangle.
right	Specifies the right position of the cropped rectangle.
bottom	Specifies the bottom position of the cropped rectangle.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException	source or destination is null.
FileNotFoundException	source does not exist.

Definition at line 3952 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.JPEGTransform ( string  source, string  destination, FREE_IMAGE_JPEG_OPERATION  operation, bool  perfect  )

static

Performs a lossless rotation or flipping on a JPEG file.

Parameters

source	Source file.
destination	Destination file; can be the source file; will be overwritten.
operation	The operation to apply.
perfect	To avoid lossy transformation, you can set the perfect parameter to true.

Returns

Returns true on success, false on failure.

Definition at line 3899 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.JPEGTransform ( string  source, string  destination, FREE_IMAGE_JPEG_OPERATION  operation, bool  perfect  )

static

Performs a lossless rotation or flipping on a JPEG file.

Parameters

source	Source file.
destination	Destination file; can be the source file; will be overwritten.
operation	The operation to apply.
perfect	To avoid lossy transformation, you can set the perfect parameter to true.

Returns

Returns true on success, false on failure.

Definition at line 3901 of file FreeImageBitmap.cs.

BitmapData FreeImageAPI.FreeImageBitmap.LockBits	(	Rectangle	rect,
		ImageLockMode	flags,
		PixelFormat	format
	)

This function is not yet implemented.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2693 of file FreeImageBitmap.cs.

BitmapData FreeImageAPI.FreeImageBitmap.LockBits	(	Rectangle	rect,
		ImageLockMode	flags,
		PixelFormat	format
	)

This function is not yet implemented.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2693 of file FreeImageBitmap.cs.

BitmapData FreeImageAPI.FreeImageBitmap.LockBits	(	Rectangle	rect,
		ImageLockMode	flags,
		PixelFormat	format,
		BitmapData	bitmapData
	)

This function is not yet implemented.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2703 of file FreeImageBitmap.cs.

BitmapData FreeImageAPI.FreeImageBitmap.LockBits	(	Rectangle	rect,
		ImageLockMode	flags,
		PixelFormat	format,
		BitmapData	bitmapData
	)

This function is not yet implemented.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2703 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.LookupSVGColor ( string  color, out byte  red, out byte  green, out byte  blue  )

static

Converts a SVG color name into a corresponding RGB value.

Parameters

color	Name of the color to convert.
red	Red component.
green	Green component.
blue	Blue component.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException

color is null.

Definition at line 3994 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.LookupSVGColor ( string  color, out byte  red, out byte  green, out byte  blue  )

static

Converts a SVG color name into a corresponding RGB value.

Parameters

color	Name of the color to convert.
red	Red component.
green	Green component.
blue	Blue component.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException

color is null.

Definition at line 3996 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.LookupX11Color ( string  color, out byte  red, out byte  green, out byte  blue  )

static

Converts a X11 color name into a corresponding RGB value.

Parameters

color	Name of the color to convert.
red	Red component.
green	Green component.
blue	Blue component.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException

color is null.

Definition at line 3976 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.LookupX11Color ( string  color, out byte  red, out byte  green, out byte  blue  )

static

Converts a X11 color name into a corresponding RGB value.

Parameters

color	Name of the color to convert.
red	Red component.
green	Green component.
blue	Blue component.

Returns

Returns true on success, false on failure.

Exceptions

ArgumentNullException

color is null.

Definition at line 3978 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.MakeTransparent

(

)

Makes the default transparent color transparent for this FreeImageBitmap.

Definition at line 2612 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.MakeTransparent().

void FreeImageAPI.FreeImageBitmap.MakeTransparent

(

)

Makes the default transparent color transparent for this FreeImageBitmap.

Definition at line 2612 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.MakeTransparent().

void FreeImageAPI.FreeImageBitmap.MakeTransparent

(

Color

transparentColor

)

Makes the specified color transparent for this FreeImageBitmap.

Parameters

transparentColor

The System.Drawing.Color structure that represents the color to make transparent.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2625 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.MakeTransparent

(

Color

transparentColor

)

Makes the specified color transparent for this FreeImageBitmap.

Parameters

transparentColor

The System.Drawing.Color structure that represents the color to make transparent.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2625 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.MultigridPoissonSolver

(

int

ncycle

)

Solves a Poisson equation, remap result pixels to [0..1] and returns the solution.

Parameters

ncycle

Number of cycles in the multigrid algorithm (usually 2 or 3)

Returns

Returns true on success, false on failure.

Definition at line 3523 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.MultigridPoissonSolver

(

int

ncycle

)

Solves a Poisson equation, remap result pixels to [0..1] and returns the solution.

Parameters

ncycle

Number of cycles in the multigrid algorithm (usually 2 or 3)

Returns

Returns true on success, false on failure.

Definition at line 3523 of file FreeImageBitmap.cs.

static FreeImageAPI.FreeImageBitmap.operator Bitmap ( FreeImageBitmap  value )

explicitstatic

Converts a FreeImageBitmap instance to a Bitmap instance.

Parameters

value

A FreeImageBitmap instance.

Returns

A new instance of Bitmap initialized to value .

The explicit conversion from FreeImageBitmap into Bitmap allows to create an instance on the fly and use it as if was a Bitmap. This way it can be directly used with a PixtureBox for example without having to call any conversion operations.

Definition at line 961 of file FreeImageBitmap.cs.

static FreeImageAPI.FreeImageBitmap.operator Bitmap ( FreeImageBitmap  value )

explicitstatic

Converts a FreeImageBitmap instance to a Bitmap instance.

Parameters

value

A FreeImageBitmap instance.

Returns

A new instance of Bitmap initialized to value .

The explicit conversion from FreeImageBitmap into Bitmap allows to create an instance on the fly and use it as if was a Bitmap. This way it can be directly used with a PixtureBox for example without having to call any conversion operations.

Definition at line 961 of file FreeImageBitmap.cs.

static FreeImageAPI.FreeImageBitmap.operator FreeImageBitmap ( Bitmap  value )

explicitstatic

Converts a Bitmap instance to a FreeImageBitmap instance.

Parameters

value

A Bitmap instance.

Returns

A new instance of FreeImageBitmap initialized to value .

The explicit conversion from Bitmap into FreeImageBitmap allows to create an instance on the fly to perform image processing operations and converting it back.

Definition at line 976 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static FreeImageAPI.FreeImageBitmap.operator FreeImageBitmap ( Bitmap  value )

explicitstatic

Converts a Bitmap instance to a FreeImageBitmap instance.

Parameters

value

A Bitmap instance.

Returns

A new instance of FreeImageBitmap initialized to value .

The explicit conversion from Bitmap into FreeImageBitmap allows to create an instance on the fly to perform image processing operations and converting it back.

Definition at line 976 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.FreeImageBitmap().

static bool FreeImageAPI.FreeImageBitmap.operator!= ( FreeImageBitmap  left, FreeImageBitmap  right  )

static

Determines whether two specified FreeImageBitmap objects have different values.

Parameters

left	A FreeImageBitmap or a null reference (Nothing in Visual Basic).
right	A FreeImageBitmap or a null reference (Nothing in Visual Basic).

Returns

true if the value of left is different from the value of right; otherwise, false.

Definition at line 1015 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.operator!= ( FreeImageBitmap  left, FreeImageBitmap  right  )

static

Determines whether two specified FreeImageBitmap objects have different values.

Parameters

left	A FreeImageBitmap or a null reference (Nothing in Visual Basic).
right	A FreeImageBitmap or a null reference (Nothing in Visual Basic).

Returns

true if the value of left is different from the value of right; otherwise, false.

Definition at line 1015 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.operator== ( FreeImageBitmap  left, FreeImageBitmap  right  )

static

Determines whether two specified FreeImageBitmap objects have the same value.

Parameters

left	A FreeImageBitmap or a null reference (Nothing in Visual Basic).
right	A FreeImageBitmap or a null reference (Nothing in Visual Basic).

Returns

true if the value of left is the same as the value of right; otherwise, false.

Definition at line 989 of file FreeImageBitmap.cs.

static bool FreeImageAPI.FreeImageBitmap.operator== ( FreeImageBitmap  left, FreeImageBitmap  right  )

static

Determines whether two specified FreeImageBitmap objects have the same value.

Parameters

left	A FreeImageBitmap or a null reference (Nothing in Visual Basic).
right	A FreeImageBitmap or a null reference (Nothing in Visual Basic).

Returns

true if the value of left is the same as the value of right; otherwise, false.

Definition at line 989 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Paste	(	FreeImageBitmap	bitmap,
		int	left,
		int	top,
		int	alpha
	)

Alpha blend or combine a sub part image with this FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance.

Parameters

bitmap	The FreeImageBitmap to paste into this instance.
left	Specifies the left position of the sub image.
top	Specifies the top position of the sub image.
alpha	alpha blend factor. The source and destination images are alpha blended if alpha=0..255. If alpha > 255, then the source image is combined to the destination image.

Returns

Returns true on success, false on failure.

Definition at line 3456 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Paste	(	FreeImageBitmap	bitmap,
		int	left,
		int	top,
		int	alpha
	)

Alpha blend or combine a sub part image with this FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance.

Parameters

bitmap	The FreeImageBitmap to paste into this instance.
left	Specifies the left position of the sub image.
top	Specifies the top position of the sub image.
alpha	alpha blend factor. The source and destination images are alpha blended if alpha=0..255. If alpha > 255, then the source image is combined to the destination image.

Returns

Returns true on success, false on failure.

Definition at line 3456 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.Paste().

bool FreeImageAPI.FreeImageBitmap.Paste	(	FreeImageBitmap	bitmap,
		Point	point,
		int	alpha
	)

Alpha blend or combine a sub part image with tthis FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance.

Parameters

bitmap	The FreeImageBitmap to paste into this instance.
point	Specifies the position of the sub image.
alpha	alpha blend factor. The source and destination images are alpha blended if alpha=0..255. If alpha > 255, then the source image is combined to the destination image.

Returns

Returns true on success, false on failure.

Definition at line 3473 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Paste().

bool FreeImageAPI.FreeImageBitmap.Paste	(	FreeImageBitmap	bitmap,
		Point	point,
		int	alpha
	)

Alpha blend or combine a sub part image with tthis FreeImageBitmap. The bit depth of bitmap must be greater than or equal to the bit depth this instance.

Parameters

bitmap	The FreeImageBitmap to paste into this instance.
point	Specifies the position of the sub image.
alpha	alpha blend factor. The source and destination images are alpha blended if alpha=0..255. If alpha > 255, then the source image is combined to the destination image.

Returns

Returns true on success, false on failure.

Definition at line 3473 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Paste().

bool FreeImageAPI.FreeImageBitmap.PreMultiplyWithAlpha

(

)

Applies the alpha value of each pixel to its color components. The aplha value stays unchanged. Only works with 32-bits color depth.

Returns

Returns true on success, false on failure.

Definition at line 3512 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.PreMultiplyWithAlpha

(

)

Applies the alpha value of each pixel to its color components. The aplha value stays unchanged. Only works with 32-bits color depth.

Returns

Returns true on success, false on failure.

Definition at line 3512 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.

Returns

Returns true on success, false on failure.

Definition at line 2971 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.Quantize().

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm .

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.

Returns

Returns true on success, false on failure.

Definition at line 2971 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Quantize().

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length.

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reservePalette	The provided palette.

Returns

Returns true on success, false on failure.

Definition at line 2987 of file FreeImageBitmap.cs.

References FreeImageAPI.MemoryArray< T >.Data, FreeImageAPI.MemoryArray< T >.Length, and FreeImageAPI.FreeImageBitmap.Quantize().

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length.

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reservePalette	The provided palette.

Returns

Returns true on success, false on failure.

Definition at line 2987 of file FreeImageBitmap.cs.

References FreeImageAPI.MemoryArray< T >.Data, FreeImageAPI.MemoryArray< T >.Length, and FreeImageAPI.FreeImageBitmap.Quantize().

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length.

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette of ReservePalette.
reservePalette	The provided palette.

Returns

Returns true on success, false on failure.

Definition at line 3004 of file FreeImageBitmap.cs.

References FreeImageAPI.MemoryArray< T >.Data, and FreeImageAPI.FreeImageBitmap.Quantize().

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		Palette	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length.

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette of ReservePalette.
reservePalette	The provided palette.

Returns

Returns true on success, false on failure.

Definition at line 3004 of file FreeImageBitmap.cs.

References FreeImageAPI.MemoryArray< T >.Data, and FreeImageAPI.FreeImageBitmap.Quantize().

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		RGBQUAD[]	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length.

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette of ReservePalette.
reservePalette	The provided palette.

Returns

Returns true on success, false on failure.

Definition at line 3021 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Quantize	(	FREE_IMAGE_QUANTIZE	algorithm,
		int	paletteSize,
		int	reserveSize,
		RGBQUAD[]	reservePalette
	)

Quantizes this FreeImageBitmap from 24 bit to 8bit creating a new palette with the specified paletteSize using the specified algorithm and the specified reservePalette palette up to the specified paletteSize length.

Parameters

algorithm	The color reduction algorithm to be used.
paletteSize	Size of the desired output palette.
reserveSize	Size of the provided palette of ReservePalette.
reservePalette	The provided palette.

Returns

Returns true on success, false on failure.

Definition at line 3021 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.RemovePropertyItem

(

int

propid

)

Removes the specified property item from this FreeImageBitmap.

Parameters

propid

The ID of the property item to remove.

Definition at line 2091 of file FreeImageBitmap.cs.

References FreeImageAPI.Metadata.MetadataTag.ID.

void FreeImageAPI.FreeImageBitmap.RemovePropertyItem

(

int

propid

)

Removes the specified property item from this FreeImageBitmap.

Parameters

propid

The ID of the property item to remove.

Definition at line 2091 of file FreeImageBitmap.cs.

References FreeImageAPI.Metadata.MetadataTag.ID.

bool FreeImageAPI.FreeImageBitmap.Rescale	(	Size	newSize,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter.

Parameters

newSize	The Size structure that represent the size of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

Returns true on success, false on failure.

Definition at line 2814 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.Rescale().

bool FreeImageAPI.FreeImageBitmap.Rescale	(	Size	newSize,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter.

Parameters

newSize	The Size structure that represent the size of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

Returns true on success, false on failure.

Definition at line 2814 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Rescale().

bool FreeImageAPI.FreeImageBitmap.Rescale	(	int	width,
		int	height,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter.

Parameters

width	Width of the new FreeImageBitmap.
height	Height of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

Returns true on success, false on failure.

Definition at line 2827 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Rescale	(	int	width,
		int	height,
		FREE_IMAGE_FILTER	filter
	)

Rescales this FreeImageBitmap to the specified size using the specified filter.

Parameters

width	Width of the new FreeImageBitmap.
height	Height of the new FreeImageBitmap.
filter	Filter to use for resizing.

Returns

Returns true on success, false on failure.

Definition at line 2827 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Rotate

(

double

angle

)

This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Parameters

angle

The angle of rotation.

Returns

Returns true on success, false on failure.

Definition at line 3140 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

bool FreeImageAPI.FreeImageBitmap.Rotate

(

double

angle

)

This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Parameters

angle

The angle of rotation.

Returns

Returns true on success, false on failure.

Definition at line 3140 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

bool FreeImageAPI.FreeImageBitmap.Rotate	(	double	angle,
		double	xShift,
		double	yShift,
		double	xOrigin,
		double	yOrigin,
		bool	useMask
	)

This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline.

Parameters

angle	The angle of rotation.
xShift	Horizontal image translation.
yShift	Vertical image translation.
xOrigin	Rotation center x-coordinate.
yOrigin	Rotation center y-coordinate.
useMask	When true the irrelevant part of the image is set to a black color, otherwise, a mirroring technique is used to fill irrelevant pixels.

Returns

Returns true on success, false on failure.

Definition at line 3247 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Rotate	(	double	angle,
		double	xShift,
		double	yShift,
		double	xOrigin,
		double	yOrigin,
		bool	useMask
	)

This method performs a rotation and / or translation of an 8-bit greyscale, 24- or 32-bit image, using a 3rd order (cubic) B-Spline.

Parameters

angle	The angle of rotation.
xShift	Horizontal image translation.
yShift	Vertical image translation.
xOrigin	Rotation center x-coordinate.
yOrigin	Rotation center y-coordinate.
useMask	When true the irrelevant part of the image is set to a black color, otherwise, a mirroring technique is used to fill irrelevant pixels.

Returns

Returns true on success, false on failure.

Definition at line 3247 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.Rotate< T >	(	double	angle,
		T?	backgroundColor
	)

This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Template Parameters

T	The type of the color to use as background.

Parameters

angle	The angle of rotation.
backgroundColor	The color used used to fill the bitmap's background.

Returns

Returns true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 3164 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

bool FreeImageAPI.FreeImageBitmap.Rotate< T >	(	double	angle,
		T?	backgroundColor
	)

This method rotates a 1-, 4-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears. For 1- and 4-bit images, rotation is limited to angles whose value is an integer multiple of 90.

Template Parameters

T	The type of the color to use as background.

Parameters

angle	The angle of rotation.
backgroundColor	The color used used to fill the bitmap's background.

Returns

Returns true on success, false on failure.

Type Constraints

T

:

struct

Definition at line 3164 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

void FreeImageAPI.FreeImageBitmap.RotateFlip

(

RotateFlipType

rotateFlipType

)

This method rotates, flips, or rotates and flips this FreeImageBitmap.

Parameters

rotateFlipType

A RotateFlipType member that specifies the type of rotation and flip to apply to this FreeImageBitmap.

Definition at line 2113 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.RotateFlip

(

RotateFlipType

rotateFlipType

)

This method rotates, flips, or rotates and flips this FreeImageBitmap.

Parameters

rotateFlipType

A RotateFlipType member that specifies the type of rotation and flip to apply to this FreeImageBitmap.

Definition at line 2113 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.Save

(

string

filename

)

Saves this FreeImageBitmap to the specified file.

Parameters

filename

A string that contains the name of the file to which to save this FreeImageBitmap.

Exceptions

ArgumentException	filename is null or empty.
Exception	Saving the image failed.

Definition at line 2214 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Save().

void FreeImageAPI.FreeImageBitmap.Save

(

string

filename

)

Saves this FreeImageBitmap to the specified file.

Parameters

filename

A string that contains the name of the file to which to save this FreeImageBitmap.

Exceptions

ArgumentException	filename is null or empty.
Exception	Saving the image failed.

Definition at line 2214 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.Save().

void FreeImageAPI.FreeImageBitmap.Save	(	string	filename,
		FREE_IMAGE_FORMAT	format
	)

Saves this FreeImageBitmap to the specified file in the specified format.

Parameters

filename	A string that contains the name of the file to which to save this FreeImageBitmap.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.

Exceptions

ArgumentException	filename is null or empty.
Exception	Saving the image failed.

Definition at line 2227 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Save().

void FreeImageAPI.FreeImageBitmap.Save	(	string	filename,
		FREE_IMAGE_FORMAT	format
	)

Saves this FreeImageBitmap to the specified file in the specified format.

Parameters

filename	A string that contains the name of the file to which to save this FreeImageBitmap.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.

Exceptions

ArgumentException	filename is null or empty.
Exception	Saving the image failed.

Definition at line 2227 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Save().

void FreeImageAPI.FreeImageBitmap.Save	(	string	filename,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_SAVE_FLAGS	flags
	)

Saves this FreeImageBitmap to the specified file in the specified format using the specified saving flags.

Parameters

filename	A string that contains the name of the file to which to save this FreeImageBitmap.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.
flags	Flags to enable or disable plugin-features.

Exceptions

ArgumentException	filename is null or empty.
Exception	Saving the image failed.

Definition at line 2242 of file FreeImageBitmap.cs.

References DirectX.flags, and DirectX.format.

void FreeImageAPI.FreeImageBitmap.Save	(	string	filename,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_SAVE_FLAGS	flags
	)

Saves this FreeImageBitmap to the specified file in the specified format using the specified saving flags.

Parameters

filename	A string that contains the name of the file to which to save this FreeImageBitmap.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.
flags	Flags to enable or disable plugin-features.

Exceptions

ArgumentException	filename is null or empty.
Exception	Saving the image failed.

Definition at line 2242 of file FreeImageBitmap.cs.

References DirectX.flags, and DirectX.format.

void FreeImageAPI.FreeImageBitmap.Save	(	Stream	stream,
		FREE_IMAGE_FORMAT	format
	)

Saves this FreeImageBitmap to the specified stream in the specified format.

Parameters

stream	The stream where this FreeImageBitmap will be saved.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.

Exceptions

ArgumentNullException	stream is a null reference.
Exception	Saving the image failed.

Definition at line 2266 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Save().

void FreeImageAPI.FreeImageBitmap.Save	(	Stream	stream,
		FREE_IMAGE_FORMAT	format
	)

Saves this FreeImageBitmap to the specified stream in the specified format.

Parameters

stream	The stream where this FreeImageBitmap will be saved.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.

Exceptions

ArgumentNullException	stream is a null reference.
Exception	Saving the image failed.

Definition at line 2266 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.Save().

void FreeImageAPI.FreeImageBitmap.Save	(	Stream	stream,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_SAVE_FLAGS	flags
	)

Saves this FreeImageBitmap to the specified stream in the specified format using the specified saving flags.

Parameters

stream	The stream where this FreeImageBitmap will be saved.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.
flags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	stream is a null reference.
Exception	Saving the image failed.

Definition at line 2280 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.Save	(	Stream	stream,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_SAVE_FLAGS	flags
	)

Saves this FreeImageBitmap to the specified stream in the specified format using the specified saving flags.

Parameters

stream	The stream where this FreeImageBitmap will be saved.
format	An FREE_IMAGE_FORMAT that specifies the format of the saved image.
flags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	stream is a null reference.
Exception	Saving the image failed.

Definition at line 2280 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

)

Adds a frame to the file specified in a previous call to the Save(String) method.

Exceptions

InvalidOperationException

This instance has not been saved to a file using Save(...) before.

Definition at line 2301 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

)

Adds a frame to the file specified in a previous call to the Save(String) method.

Exceptions

InvalidOperationException

This instance has not been saved to a file using Save(...) before.

Definition at line 2301 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

int

insertPosition

)

Adds a frame to the file specified in a previous call to the Save(String) method.

Parameters

insertPosition

The position at which the frame should be inserted.

Exceptions

InvalidOperationException	This instance has not yet been saved to a file using the Save(...) method.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2313 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

int

insertPosition

)

Adds a frame to the file specified in a previous call to the Save(String) method.

Parameters

insertPosition

The position at which the frame should be inserted.

Exceptions

InvalidOperationException	This instance has not yet been saved to a file using the Save(...) method.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2313 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

FreeImageBitmap

bitmap

)

Adds a frame to the file specified in a previous call to the Save(String) method.

Parameters

bitmap

A FreeImageBitmap that contains the frame to add.

Exceptions

InvalidOperationException

This instance has not yet been saved to a file using the Save(...) method.

Definition at line 2324 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

FreeImageBitmap

bitmap

)

Adds a frame to the file specified in a previous call to the Save(String) method.

Parameters

bitmap

A FreeImageBitmap that contains the frame to add.

Exceptions

InvalidOperationException

This instance has not yet been saved to a file using the Save(...) method.

Definition at line 2324 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	FreeImageBitmap	bitmap,
		int	insertPosition
	)

Adds a frame to the file specified in a previous call to the Save(String) method.

Parameters

bitmap	A FreeImageBitmap that contains the frame to add.
insertPosition	The position at which the frame should be inserted.

Exceptions

InvalidOperationException	This instance has not yet been saved to a file using the Save(...) method.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2347 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	FreeImageBitmap	bitmap,
		int	insertPosition
	)

Adds a frame to the file specified in a previous call to the Save(String) method.

Parameters

bitmap	A FreeImageBitmap that contains the frame to add.
insertPosition	The position at which the frame should be inserted.

Exceptions

InvalidOperationException	This instance has not yet been saved to a file using the Save(...) method.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2347 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

string

filename

)

Adds a frame to the file specified.

Parameters

filename

File to add this frame to.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.

Definition at line 2370 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd

(

string

filename

)

Adds a frame to the file specified.

Parameters

filename

File to add this frame to.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.

Definition at line 2370 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	string	filename,
		int	insertPosition
	)

Adds a frame to the file specified.

Parameters

filename	File to add this frame to.
insertPosition	The position at which the frame should be inserted.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2389 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	string	filename,
		int	insertPosition
	)

Adds a frame to the file specified.

Parameters

filename	File to add this frame to.
insertPosition	The position at which the frame should be inserted.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2389 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	string	filename,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	loadFlags,
		FREE_IMAGE_SAVE_FLAGS	saveFlags
	)

Adds a frame to the file specified using the specified parameters.

Parameters

filename	File to add this frame to.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.

Definition at line 2410 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	string	filename,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	loadFlags,
		FREE_IMAGE_SAVE_FLAGS	saveFlags
	)

Adds a frame to the file specified using the specified parameters.

Parameters

filename	File to add this frame to.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.

Definition at line 2410 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	string	filename,
		int	insertPosition,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	loadFlags,
		FREE_IMAGE_SAVE_FLAGS	saveFlags
	)

Adds a frame to the file specified using the specified parameters.

Parameters

filename	File to add this frame to.
insertPosition	The position at which the frame should be inserted.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2436 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

void FreeImageAPI.FreeImageBitmap.SaveAdd	(	string	filename,
		int	insertPosition,
		FREE_IMAGE_FORMAT	format,
		FREE_IMAGE_LOAD_FLAGS	loadFlags,
		FREE_IMAGE_SAVE_FLAGS	saveFlags
	)

Adds a frame to the file specified using the specified parameters.

Parameters

filename	File to add this frame to.
insertPosition	The position at which the frame should be inserted.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename is a null reference.
FileNotFoundException	filename does not exist.
Exception	Saving the image has failed.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 2436 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.SaveAdd().

static void FreeImageAPI.FreeImageBitmap.SaveAdd ( string  filename, FreeImageBitmap  bitmap, FREE_IMAGE_FORMAT  format, FREE_IMAGE_LOAD_FLAGS  loadFlags, FREE_IMAGE_SAVE_FLAGS  saveFlags  )

static

Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an to a multiple-frame image.

Parameters

filename	File to add this frame to.
bitmap	A FreeImageBitmap that contains the frame to add.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename or bitmap is null.
FileNotFoundException	filename does not exist.
Exception	Saving the image failed.

Definition at line 4051 of file FreeImageBitmap.cs.

References DirectX.format, and FreeImageAPI.FIMULTIBITMAP.IsNull.

static void FreeImageAPI.FreeImageBitmap.SaveAdd ( string  filename, FreeImageBitmap  bitmap, FREE_IMAGE_FORMAT  format, FREE_IMAGE_LOAD_FLAGS  loadFlags, FREE_IMAGE_SAVE_FLAGS  saveFlags  )

static

Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an to a multiple-frame image.

Parameters

filename	File to add this frame to.
bitmap	A FreeImageBitmap that contains the frame to add.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename or bitmap is null.
FileNotFoundException	filename does not exist.
Exception	Saving the image failed.

Definition at line 4053 of file FreeImageBitmap.cs.

References DirectX.format, and FreeImageAPI.FIMULTIBITMAP.IsNull.

static void FreeImageAPI.FreeImageBitmap.SaveAdd ( string  filename, FreeImageBitmap  bitmap, int  insertPosition, FREE_IMAGE_FORMAT  format, FREE_IMAGE_LOAD_FLAGS  loadFlags, FREE_IMAGE_SAVE_FLAGS  saveFlags  )

static

Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an image to a multiple-frame image.

Parameters

filename	File to add this frame to.
bitmap	A FreeImageBitmap that contains the frame to add.
insertPosition	The position of the inserted frame.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename or bitmap is null.
FileNotFoundException	filename does not exist.
Exception	Saving the image failed.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 4104 of file FreeImageBitmap.cs.

References DirectX.format, and FreeImageAPI.FIMULTIBITMAP.IsNull.

static void FreeImageAPI.FreeImageBitmap.SaveAdd ( string  filename, FreeImageBitmap  bitmap, int  insertPosition, FREE_IMAGE_FORMAT  format, FREE_IMAGE_LOAD_FLAGS  loadFlags, FREE_IMAGE_SAVE_FLAGS  saveFlags  )

static

Adds a specified frame to the file specified using the specified parameters. Use this method to save selected frames from an image to a multiple-frame image.

Parameters

filename	File to add this frame to.
bitmap	A FreeImageBitmap that contains the frame to add.
insertPosition	The position of the inserted frame.
format	Format of the image.
loadFlags	Flags to enable or disable plugin-features.
saveFlags	Flags to enable or disable plugin-features.

Exceptions

ArgumentNullException	filename or bitmap is null.
FileNotFoundException	filename does not exist.
Exception	Saving the image failed.
ArgumentOutOfRangeException	insertPosition is out of range.

Definition at line 4106 of file FreeImageBitmap.cs.

References DirectX.format, and FreeImageAPI.FIMULTIBITMAP.IsNull.

void FreeImageAPI.FreeImageBitmap.SelectActiveFrame

(

int

frameIndex

)

Selects the frame specified by the index.

Parameters

frameIndex

The index of the active frame.

Exceptions

ArgumentOutOfRangeException	frameIndex is out of range.
Exception	The operation failed.
InvalidOperationException	The source of the bitmap is not available.

Definition at line 2461 of file FreeImageBitmap.cs.

References DirectX.format, FreeImageAPI.FIMULTIBITMAP.IsNull, and FreeImageAPI.FIBITMAP.IsNull.

void FreeImageAPI.FreeImageBitmap.SelectActiveFrame

(

int

frameIndex

)

Selects the frame specified by the index.

Parameters

frameIndex

The index of the active frame.

Exceptions

ArgumentOutOfRangeException	frameIndex is out of range.
Exception	The operation failed.
InvalidOperationException	The source of the bitmap is not available.

Definition at line 2461 of file FreeImageBitmap.cs.

References DirectX.format, FreeImageAPI.FIMULTIBITMAP.IsNull, and FreeImageAPI.FIBITMAP.IsNull.

bool FreeImageAPI.FreeImageBitmap.SetChannel	(	FreeImageBitmap	bitmap,
		FREE_IMAGE_COLOR_CHANNEL	channel
	)

Insert a 8-bit dib into a 24- or 32-bit image. Both images must have to same width and height.

Parameters

bitmap	The FreeImageBitmap to insert.
channel	The color channel to replace.

Returns

Returns true on success, false on failure.

Definition at line 3376 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.SetChannel	(	FreeImageBitmap	bitmap,
		FREE_IMAGE_COLOR_CHANNEL	channel
	)

Insert a 8-bit dib into a 24- or 32-bit image. Both images must have to same width and height.

Parameters

bitmap	The FreeImageBitmap to insert.
channel	The color channel to replace.

Returns

Returns true on success, false on failure.

Definition at line 3376 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.SetComplexChannel	(	FreeImageBitmap	bitmap,
		FREE_IMAGE_COLOR_CHANNEL	channel
	)

Set the real or imaginary part of a complex image. Both images must have to same width and height.

Parameters

bitmap	The FreeImageBitmap to insert.
channel	The color channel to replace.

Returns

Returns true on success, false on failure.

Definition at line 3407 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.SetComplexChannel	(	FreeImageBitmap	bitmap,
		FREE_IMAGE_COLOR_CHANNEL	channel
	)

Set the real or imaginary part of a complex image. Both images must have to same width and height.

Parameters

bitmap	The FreeImageBitmap to insert.
channel	The color channel to replace.

Returns

Returns true on success, false on failure.

Definition at line 3407 of file FreeImageBitmap.cs.

unsafe void FreeImageAPI.FreeImageBitmap.SetPixel	(	int	x,
		int	y,
		Color	color
	)

Sets the System.Drawing.Color of the specified pixel in this FreeImageBitmap.

Parameters

x	The x-coordinate of the pixel to set.
y	The y-coordinate of the pixel to set.
color	A System.Drawing.Color structure that represents the color to assign to the specified pixel.

Exceptions

Exception	The operation failed.
NotSupportedException	The type of this bitmap is not supported.

Definition at line 2640 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

unsafe void FreeImageAPI.FreeImageBitmap.SetPixel	(	int	x,
		int	y,
		Color	color
	)

Sets the System.Drawing.Color of the specified pixel in this FreeImageBitmap.

Parameters

x	The x-coordinate of the pixel to set.
y	The y-coordinate of the pixel to set.
color	A System.Drawing.Color structure that represents the color to assign to the specified pixel.

Exceptions

Exception	The operation failed.
NotSupportedException	The type of this bitmap is not supported.

Definition at line 2640 of file FreeImageBitmap.cs.

References FreeImageAPI.FreeImageBitmap.ColorDepth.

void FreeImageAPI.FreeImageBitmap.SetResolution	(	float	xDpi,
		float	yDpi
	)

Sets the resolution for this FreeImageBitmap.

Parameters

xDpi	The horizontal resolution, in dots per inch, of this FreeImageBitmap.
yDpi	The vertical resolution, in dots per inch, of this FreeImageBitmap.

Definition at line 2681 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.SetResolution	(	float	xDpi,
		float	yDpi
	)

Sets the resolution for this FreeImageBitmap.

Parameters

xDpi	The horizontal resolution, in dots per inch, of this FreeImageBitmap.
yDpi	The vertical resolution, in dots per inch, of this FreeImageBitmap.

Definition at line 2681 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.SwapColors	(	RGBQUAD	color_a,
		RGBQUAD	color_b,
		bool	ignore_alpha
	)

Swaps two specified colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image.

Parameters

color_a	One of the two colors to be swapped.
color_b	The other of the two colors to be swapped.
ignore_alpha	If true, 32-bit images and colors are treated as 24-bit.

Returns

The total number of pixels changed.

Definition at line 3594 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.SwapColors	(	RGBQUAD	color_a,
		RGBQUAD	color_b,
		bool	ignore_alpha
	)

Swaps two specified colors on a 1-, 4- or 8-bit palletized or a 16-, 24- or 32-bit high color image.

Parameters

color_a	One of the two colors to be swapped.
color_b	The other of the two colors to be swapped.
ignore_alpha	If true, 32-bit images and colors are treated as 24-bit.

Returns

The total number of pixels changed.

Definition at line 3594 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.SwapPaletteIndices	(	byte	index_a,
		byte	index_b
	)

Swaps two specified palette indices on a 1-, 4- or 8-bit palletized image.

Parameters

index_a	One of the two palette indices to be swapped.
index_b	The other of the two palette indices to be swapped.

Returns

The total number of pixels changed.

Definition at line 3639 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.SwapPaletteIndices	(	byte	index_a,
		byte	index_b
	)

Swaps two specified palette indices on a 1-, 4- or 8-bit palletized image.

Parameters

index_a	One of the two palette indices to be swapped.
index_b	The other of the two palette indices to be swapped.

Returns

The total number of pixels changed.

Definition at line 3641 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.TmoDrago03	(	double	gamma,
		double	exposure
	)

Converts a High Dynamic Range image to a 24-bit RGB image using a global operator based on logarithmic compression of luminance values, imitating the human response to light.

Parameters

gamma	A gamma correction that is applied after the tone mapping. A value of 1 means no correction.
exposure	Scale factor allowing to adjust the brightness of the output image.

Returns

Returns true on success, false on failure.

Definition at line 3102 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.TmoDrago03	(	double	gamma,
		double	exposure
	)

Converts a High Dynamic Range image to a 24-bit RGB image using a global operator based on logarithmic compression of luminance values, imitating the human response to light.

Parameters

gamma	A gamma correction that is applied after the tone mapping. A value of 1 means no correction.
exposure	Scale factor allowing to adjust the brightness of the output image.

Returns

Returns true on success, false on failure.

Definition at line 3102 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.TmoFattal02	(	double	color_saturation,
		double	attenuation
	)

Apply the Gradient Domain High Dynamic Range Compression to a RGBF image and convert to 24-bit RGB.

Parameters

color_saturation	Color saturation (s parameter in the paper) in [0.4..0.6]
attenuation	Atenuation factor (beta parameter in the paper) in [0.8..0.9]

Returns

Returns true on success, false on failure.

Definition at line 3127 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.TmoFattal02	(	double	color_saturation,
		double	attenuation
	)

Apply the Gradient Domain High Dynamic Range Compression to a RGBF image and convert to 24-bit RGB.

Parameters

color_saturation	Color saturation (s parameter in the paper) in [0.4..0.6]
attenuation	Atenuation factor (beta parameter in the paper) in [0.8..0.9]

Returns

Returns true on success, false on failure.

Definition at line 3127 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.TmoReinhard05	(	double	intensity,
		double	contrast
	)

Converts a High Dynamic Range image to a 24-bit RGB image using a global operator inspired by photoreceptor physiology of the human visual system.

Parameters

intensity	Controls the overall image intensity in the range [-8, 8].
contrast	Controls the overall image contrast in the range [0.3, 1.0[.

Returns

Returns true on success, false on failure.

Definition at line 3115 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.TmoReinhard05	(	double	intensity,
		double	contrast
	)

Converts a High Dynamic Range image to a 24-bit RGB image using a global operator inspired by photoreceptor physiology of the human visual system.

Parameters

intensity	Controls the overall image intensity in the range [-8, 8].
contrast	Controls the overall image contrast in the range [0.3, 1.0[.

Returns

Returns true on success, false on failure.

Definition at line 3115 of file FreeImageBitmap.cs.

Bitmap FreeImageAPI.FreeImageBitmap.ToBitmap

(

)

Converts this FreeImageBitmap instance to a Bitmap instance.

Returns

A new instance of Bitmap initialized this instance.

Definition at line 1809 of file FreeImageBitmap.cs.

Bitmap FreeImageAPI.FreeImageBitmap.ToBitmap

(

)

Converts this FreeImageBitmap instance to a Bitmap instance.

Returns

A new instance of Bitmap initialized this instance.

Definition at line 1809 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.UnlockBits

(

BitmapData

bitmapdata

)

This function is not yet implemented.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2713 of file FreeImageBitmap.cs.

void FreeImageAPI.FreeImageBitmap.UnlockBits

(

BitmapData

bitmapdata

)

This function is not yet implemented.

Exceptions

NotImplementedException

This method is not implemented.

Definition at line 2713 of file FreeImageBitmap.cs.

Property Documentation

Color FreeImageAPI.FreeImageBitmap.BackgroundColor

getset

Gets or sets the background color of this FreeImageBitmap. In case the value is null, the background color is removed.

Exceptions

InvalidOperationException	Get: There is no background color available.
Exception	Set: Setting background color failed.

Definition at line 1335 of file FreeImageBitmap.cs.

IntPtr FreeImageAPI.FreeImageBitmap.Bits

get

Pointer to the data-bits of this FreeImageBitmap.

Definition at line 1361 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.BlueMask

get

Bit pattern describing the blue color component of a pixel in this FreeImageBitmap.

Definition at line 1262 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.GetScanline().

int FreeImageAPI.FreeImageBitmap.ColorDepth

get

The size of one pixel in the bitmap in bits.

Definition at line 1066 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.GetPixel(), FreeImageAPI.FreeImageBitmap.GetRotatedInstance(), FreeImageAPI.FreeImageBitmap.GetRotatedInstance< T >(), FreeImageAPI.FreeImageBitmap.Rotate(), FreeImageAPI.FreeImageBitmap.Rotate< T >(), and FreeImageAPI.FreeImageBitmap.SetPixel().

int FreeImageAPI.FreeImageBitmap.ColorsUsed

get

Number of palette entries.

Definition at line 1040 of file FreeImageBitmap.cs.

FREE_IMAGE_COLOR_TYPE FreeImageAPI.FreeImageBitmap.ColorType

get

Investigates the color type of this FreeImageBitmap by reading the bitmaps pixel bits and analysing them.

Definition at line 1226 of file FreeImageBitmap.cs.

string FreeImageAPI.FreeImageBitmap.Comment

getset

Gets or sets the comment of this FreeImageBitmap. Supported formats are JPEG, PNG and GIF.

Definition at line 1630 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.DataSize

get

Size of the bitmap in memory.

Definition at line 1114 of file FreeImageBitmap.cs.

unsafe int FreeImageAPI.FreeImageBitmap.Flags

get

Gets attribute flags for the pixel data of this FreeImageBitmap.

Definition at line 1409 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.FrameCount

get

Gets the number of frames in this FreeImageBitmap.

Definition at line 1677 of file FreeImageBitmap.cs.

FREE_IMAGE_TYPE ImageType FreeImageAPI.FreeImageBitmap.get

Type of the bitmap.

Definition at line 1030 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.GreenMask

get

Bit pattern describing the green color component of a pixel in this FreeImageBitmap.

Definition at line 1250 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.GetScanline().

bool FreeImageAPI.FreeImageBitmap.HasBackgroundColor

get

Gets whether this FreeImageBitmap has a file background color.

Definition at line 1320 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.HasPalette

get

Returns whether this FreeImageBitmap has a palette.

Definition at line 1647 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.Height

get

Height of the bitmap in pixel units.

Definition at line 1090 of file FreeImageBitmap.cs.

float FreeImageAPI.FreeImageBitmap.HorizontalResolution

getset

Gets the horizontal resolution, in pixels per inch, of this FreeImageBitmap.

Definition at line 1167 of file FreeImageBitmap.cs.

FIICCPROFILE FreeImageAPI.FreeImageBitmap.ICCProfile

get

Gets the ICCProfile structure of this FreeImageBitmap.

Definition at line 1689 of file FreeImageBitmap.cs.

FREE_IMAGE_FORMAT FreeImageAPI.FreeImageBitmap.ImageFormat

get

Gets the format of the original image in case this FreeImageBitmap was loaded from a file or stream.

Definition at line 1702 of file FreeImageBitmap.cs.

FREE_IMAGE_TYPE FreeImageAPI.FreeImageBitmap.ImageType

get

Type of the bitmap.

Definition at line 1028 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.ConvertType(), and FreeImageAPI.FreeImageBitmap.GetTypeConvertedInstance().

BITMAPINFO FreeImageAPI.FreeImageBitmap.Info

get

Returns the BITMAPINFO structure of a this FreeImageBitmap.

Definition at line 1213 of file FreeImageBitmap.cs.

BITMAPINFOHEADER FreeImageAPI.FreeImageBitmap.InfoHeader

get

Returns the BITMAPINFOHEADER structure of this FreeImageBitmap.

Definition at line 1201 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.IsDisposed

get

Gets whether this FreeImageBitmap has been disposed.

Definition at line 1606 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.ISRgb555

get

Gets whether the bitmap is RGB 555.

Definition at line 1143 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.IsRGB555

get

Gets whether the bitmap is RGB 555.

Definition at line 1143 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.ISRgb565

get

Gets whether the bitmap is RGB 565.

Definition at line 1155 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.IsRGB565

get

Gets whether the bitmap is RGB 565.

Definition at line 1155 of file FreeImageBitmap.cs.

bool FreeImageAPI.FreeImageBitmap.IsTransparent

getset

Gets or sets whether this FreeImageBitmap is transparent.

Definition at line 1303 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.Line

get

Width, in bytes, of this FreeImageBitmap.

Definition at line 1373 of file FreeImageBitmap.cs.

ImageMetadata FreeImageAPI.FreeImageBitmap.Metadata

get

Gets a new instance of a metadata representing class.

Definition at line 1617 of file FreeImageBitmap.cs.

Palette FreeImageAPI.FreeImageBitmap.Palette

get

Returns a structure that represents the palette of a FreeImage bitmap.

Exceptions

InvalidOperationException

HasPalette is false.

Definition at line 1127 of file FreeImageBitmap.cs.

SizeF FreeImageAPI.FreeImageBitmap.PhysicalDimension

get

Gets the width and height of this FreeImageBitmap.

Definition at line 1489 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.Pitch

get

Returns the width of the bitmap in bytes, rounded to the next 32-bit boundary.

Definition at line 1102 of file FreeImageBitmap.cs.

PixelFormat FreeImageAPI.FreeImageBitmap.PixelFormat

get

Gets the pixel format for this FreeImageBitmap.

Definition at line 1501 of file FreeImageBitmap.cs.

int [] FreeImageAPI.FreeImageBitmap.PropertyIdList

get

Gets IDs of the property items stored in this FreeImageBitmap.

Definition at line 1513 of file FreeImageBitmap.cs.

PropertyItem [] FreeImageAPI.FreeImageBitmap.PropertyItems

get

Gets all the property items (pieces of metadata) stored in this FreeImageBitmap.

Definition at line 1536 of file FreeImageBitmap.cs.

ImageFormat FreeImageAPI.FreeImageBitmap.RawFormat

get

Gets the format of this FreeImageBitmap.

Definition at line 1559 of file FreeImageBitmap.cs.

uint FreeImageAPI.FreeImageBitmap.RedMask

get

Bit pattern describing the red color component of a pixel in this FreeImageBitmap.

Definition at line 1238 of file FreeImageBitmap.cs.

Referenced by FreeImageAPI.FreeImageBitmap.GetScanline().

IntPtr FreeImageAPI.FreeImageBitmap.Scan0

get

Pointer to the scanline of the top most pixel row of this FreeImageBitmap.

Definition at line 1385 of file FreeImageBitmap.cs.

Size FreeImageAPI.FreeImageBitmap.Size

get

Gets the width and height, in pixels, of this FreeImageBitmap.

Definition at line 1577 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.Stride

get

Width, in bytes, of this FreeImageBitmap. In case this FreeImageBitmap is top down Stride will be positive, else negative.

Definition at line 1398 of file FreeImageBitmap.cs.

Object FreeImageAPI.FreeImageBitmap.Tag

getset

Gets or sets an object that provides additional data about the FreeImageBitmap.

Definition at line 1589 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.TransparencyCount

get

Number of transparent colors in a palletised FreeImageBitmap.

Definition at line 1274 of file FreeImageBitmap.cs.

byte [] FreeImageAPI.FreeImageBitmap.TransparencyTable

getset

Get or sets transparency table of this FreeImageBitmap.

Definition at line 1286 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.TransparentIndex

getset

Gets or sets the entry used as transparent color in this FreeImageBitmap. Only works for 1-, 4- and 8-bpp.

Definition at line 1660 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.UniqueColors

get

The number of unique colors actually used by the bitmap. This might be different from what ColorsUsed returns, which actually returns the palette size for palletised images. Works for FIT_BITMAP type bitmaps only.

Definition at line 1054 of file FreeImageBitmap.cs.

float FreeImageAPI.FreeImageBitmap.VerticalResolution

getset

Gets the vertical resolution, in pixels per inch, of this FreeImageBitmap.

Definition at line 1184 of file FreeImageBitmap.cs.

int FreeImageAPI.FreeImageBitmap.Width

get

Width of the bitmap in pixel units.

Definition at line 1078 of file FreeImageBitmap.cs.

---

The documentation for this class was generated from the following file:

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/tools/SiliconStudio.TextureConverter/Backend/Wrappers/FINetWrapper/Classes/FreeImageBitmap.cs