BmpImage Class
A bmp image (supports BMP, DIB formats).
Inheritance Hierarchy

Namespace: Aspose.Imaging.FileFormats.Bmp
Assembly: Aspose.Imaging (in Aspose.Imaging.dll) Version: 19.9
Syntax
public sealed class BmpImage : RasterCachedImage

The BmpImage type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleBmpImage(Stream)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(String)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(RasterImage)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(Int32, Int32)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(Int32, Int32, UInt16, IColorPalette)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(Stream, UInt16, BitmapCompression, Double, Double)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(String, UInt16, BitmapCompression, Double, Double)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(RasterImage, UInt16, BitmapCompression, Double, Double)
Initializes a new instance of the BmpImage class.
Public methodCode exampleBmpImage(Int32, Int32, UInt16, IColorPalette, BitmapCompression, Double, Double)
Initializes a new instance of the BmpImage class.
Properties
  NameDescription
Public propertyAutoAdjustPalette
Gets or sets a value indicating whether automatic adjust palette.
(Inherited from Image.)
Public propertyBackgroundColor
Gets or sets a value for the background color.
(Inherited from Image.)
Public propertyCode exampleBitmapInfoHeader
Gets the bitmap information header.
Public propertyCode exampleBitsPerPixel
Gets the image bits per pixel count.
(Overrides ImageBitsPerPixel.)
Public propertyBounds
Gets the image bounds.
(Inherited from Image.)
Public propertyBufferSizeHint
Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
(Inherited from Image.)
Public propertyCode exampleCompression
Gets the image compression.
Public propertyContainer
Gets the Image container.
(Inherited from Image.)
Public propertyDataStreamContainer
Gets the object's data stream.
(Inherited from DataStreamSupporter.)
Public propertyDisposed
Gets a value indicating whether this instance is disposed.
(Inherited from DisposableObject.)
Public propertyCode exampleFileFormat
Gets a value of file format
(Overrides ImageFileFormat.)
Public propertyCode exampleHasAlpha
Gets a value indicating whether this instance has alpha.
(Inherited from RasterImage.)
Public propertyHasBackgroundColor
Gets or sets a value indicating whether image has background color.
(Inherited from Image.)
Public propertyHasTransparentColor
Gets a value indicating whether image has transparent color.
(Inherited from RasterImage.)
Public propertyCode exampleHeight
Gets the image height.
(Overrides ImageHeight.)
Public propertyCode exampleHorizontalResolution
Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage.
(Overrides RasterImageHorizontalResolution.)
Public propertyImageOpacity
Gets opacity of this image.
(Inherited from RasterImage.)
Public propertyInterruptMonitor
Gets or sets the interrupt monitor.
(Inherited from Image.)
Public propertyIsCached
Gets a value indicating whether image data is cached currently.
(Inherited from RasterCachedImage.)
Public propertyIsRawDataAvailable
Gets a value indicating whether raw data loading is available.
(Inherited from RasterImage.)
Public propertyPalette
Gets or sets the color palette.
(Inherited from Image.)
Public propertyCode examplePremultiplyComponents
Gets or sets a value indicating whether the image components must be premultiplied.
(Inherited from RasterImage.)
Public propertyRawCustomColorConverter
Gets or sets the custom color converter
(Inherited from RasterImage.)
Public propertyCode exampleRawDataFormat
Gets the raw data format.
(Overrides RasterImageRawDataFormat.)
Public propertyRawDataSettings
Gets the current raw data settings. Note when using these settings the data loads without conversion.
(Inherited from RasterImage.)
Public propertyRawFallbackIndex
Gets or sets the fallback index to use when palette index is out of bounds
(Inherited from RasterImage.)
Public propertyRawIndexedColorConverter
Gets or sets the indexed color converter
(Inherited from RasterImage.)
Public propertyCode exampleRawLineSize
Gets the raw line size in bytes.
(Overrides RasterImageRawLineSize.)
Public propertyCode exampleSize
Gets the image size.
(Inherited from Image.)
Public propertyTransparentColor
Gets the image transparent color.
(Inherited from RasterImage.)
Public propertyUpdateXmpData
Gets or sets a value indicating whether to update the XMP metadata.
(Inherited from RasterImage.)
Public propertyUseRawData
Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
(Inherited from RasterImage.)
Public propertyCode exampleVerticalResolution
Gets or sets the vertical resolution, in pixels per inch, of this RasterImage.
(Overrides RasterImageVerticalResolution.)
Public propertyCode exampleWidth
Gets the image width.
(Overrides ImageWidth.)
Public propertyXmpData
Gets or sets the XMP metadata.
(Inherited from RasterImage.)
Methods
  NameDescription
Public methodCode exampleAdjustBrightness
Adjust of a brightness for image.
(Inherited from RasterCachedImage.)
Public methodCode exampleAdjustContrast
Image contrasting
(Inherited from RasterCachedImage.)
Public methodCode exampleAdjustGamma(Single)
Gamma-correction of an image.
(Inherited from RasterCachedImage.)
Public methodCode exampleAdjustGamma(Single, Single, Single)
Gamma-correction of an image.
(Inherited from RasterCachedImage.)
Public methodCode exampleBinarizeBradley(Double)
Binarization of an image using Bradley's adaptive thresholding algorithm using the integral image thresholding
(Inherited from RasterCachedImage.)
Public methodCode exampleBinarizeBradley(Double, Int32)
Binarization of an image using Bradley's adaptive thresholding algorithm using the integral image thresholding
(Inherited from RasterCachedImage.)
Public methodCode exampleBinarizeFixed
Binarization of an image with predefined threshold
(Inherited from RasterCachedImage.)
Public methodCode exampleBinarizeOtsu
Binarization of an image with Otsu thresholding
(Inherited from RasterCachedImage.)
Public methodCode exampleCacheData
Caches the data and ensures no additional data loading will be performed from the underlying DataStreamContainer.
(Inherited from RasterCachedImage.)
Public methodCode exampleCanSave
Determines whether image can be saved to the specified file format represented by the passed save options.
(Inherited from Image.)
Public methodCode exampleCrop(Rectangle)
Cropping the image.
(Inherited from RasterCachedImage.)
Public methodCode exampleCrop(Int32, Int32, Int32, Int32)
Crop image with shifts.
(Inherited from RasterImage.)
Public methodCode exampleDispose
Disposes the current instance.
(Inherited from DisposableObject.)
Public methodCode exampleDither(DitheringMethod, Int32)
Performs dithering on the current image.
(Inherited from RasterImage.)
Public methodDither(DitheringMethod, Int32, IColorPalette)
Performs dithering on the current image.
(Inherited from RasterCachedImage.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodCode exampleFilter
Filters the specified rectangle.
(Inherited from RasterImage.)
Public methodCode exampleGetArgb32Pixel
Gets an image 32-bit ARGB pixel.
(Inherited from RasterImage.)
Public methodGetDefaultArgb32Pixels
Gets the default 32-bit ARGB pixels array.
(Inherited from RasterImage.)
Public methodGetDefaultOptions
Gets the default options.
(Overrides ImageGetDefaultOptions(Object).)
Public methodGetDefaultPixels
Gets the default pixels array using partial pixel loader.
(Inherited from RasterImage.)
Public methodGetDefaultRawData(Rectangle, RawDataSettings)
Gets the default raw data array.
(Inherited from RasterImage.)
Public methodGetDefaultRawData(Rectangle, IPartialRawDataLoader, RawDataSettings)
Gets the default raw data array using partial pixel loader.
(Inherited from RasterImage.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetModifyDate
Gets the date and time the resource image was last modified.
(Inherited from RasterImage.)
Public methodGetOriginalOptions
Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the Save(String) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Save(String, ImageOptionsBase) method as the second parameter.
(Inherited from Image.)
Public methodCode exampleGetPixel
Gets an image pixel.
(Inherited from RasterImage.)
Public methodGetSkewAngle
Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning.
(Inherited from RasterImage.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodCode exampleGrayscale
Transformation of an image to its grayscale representation
(Inherited from RasterCachedImage.)
Public methodCode exampleLoadArgb32Pixels
Loads 32-bit ARGB pixels.
(Inherited from RasterImage.)
Public methodCode exampleLoadArgb64Pixels
Loads 64-bit ARGB pixels.
(Inherited from RasterImage.)
Public methodLoadCmyk32Pixels
Loads pixels in CMYK format.
(Inherited from RasterImage.)
Public methodLoadCmykPixels Obsolete.
Loads pixels in CMYK format. This method is deprecated. Please use more effective the LoadCmyk32Pixels(Rectangle) method.
(Inherited from RasterImage.)
Public methodCode exampleLoadPartialArgb32Pixels
Loads 32-bit ARGB pixels partially by packs.
(Inherited from RasterImage.)
Public methodCode exampleLoadPartialPixels
Loads pixels partially by packs.
(Inherited from RasterImage.)
Public methodCode exampleLoadPixels
Loads pixels.
(Inherited from RasterImage.)
Public methodCode exampleLoadRawData(Rectangle, RawDataSettings, IPartialRawDataLoader)
Loads raw data.
(Inherited from RasterImage.)
Public methodLoadRawData(Rectangle, Rectangle, RawDataSettings, IPartialRawDataLoader)
Loads raw data.
(Inherited from RasterImage.)
Public methodNormalizeAngle
Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate(Single) methods.
(Inherited from RasterImage.)
Public methodNormalizeAngle(Boolean, Color)
Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate(Single, Boolean, Color) methods.
(Inherited from RasterImage.)
Public methodReadArgb32ScanLine
Reads the whole scan line by the specified scan line index.
(Inherited from RasterImage.)
Public methodReadScanLine
Reads the whole scan line by the specified scan line index.
(Inherited from RasterImage.)
Public methodReplaceColor(Int32, Byte, Int32)
Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
(Inherited from RasterImage.)
Public methodReplaceColor(Color, Byte, Color)
Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
(Inherited from RasterImage.)
Public methodReplaceNonTransparentColors(Int32)
Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
(Inherited from RasterImage.)
Public methodReplaceNonTransparentColors(Color)
Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
(Inherited from RasterImage.)
Public methodResize(Int32, Int32)
Resizes the image. The default LeftTopToLeftTop is used.
(Inherited from Image.)
Public methodCode exampleResize(Int32, Int32, ImageResizeSettings)
Resizes the image.
(Inherited from RasterCachedImage.)
Public methodCode exampleResize(Int32, Int32, ResizeType)
Resizes the image.
(Inherited from RasterCachedImage.)
Public methodResizeHeightProportionally(Int32)
Resizes the height proportionally.
(Inherited from Image.)
Public methodResizeHeightProportionally(Int32, ImageResizeSettings)
Resizes the height proportionally.
(Inherited from Image.)
Public methodCode exampleResizeHeightProportionally(Int32, ResizeType)
Resizes the height proportionally.
(Inherited from Image.)
Public methodResizeWidthProportionally(Int32)
Resizes the width proportionally.
(Inherited from Image.)
Public methodResizeWidthProportionally(Int32, ImageResizeSettings)
Resizes the width proportionally.
(Inherited from Image.)
Public methodCode exampleResizeWidthProportionally(Int32, ResizeType)
Resizes the width proportionally.
(Inherited from Image.)
Public methodRotate(Single)
Rotate image around the center.
(Inherited from RasterImage.)
Public methodRotate(Single, Boolean, Color)
Rotate image around the center.
(Inherited from RasterCachedImage.)
Public methodCode exampleRotateFlip
Rotates, flips, or rotates and flips the image.
(Inherited from RasterCachedImage.)
Public methodCode exampleSave
Saves the image data to the underlying stream.
(Inherited from Image.)
Public methodSave(Stream)
Saves the object's data to the specified stream.
(Inherited from DataStreamSupporter.)
Public methodSave(String)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodSave(String, Boolean)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodCode exampleSave(Stream, ImageOptionsBase)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(String, ImageOptionsBase)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(Stream, ImageOptionsBase, Rectangle)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(String, ImageOptionsBase, Rectangle)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSaveArgb32Pixels
Saves the 32-bit ARGB pixels.
(Inherited from RasterImage.)
Public methodCode exampleSaveCmyk32Pixels
Saves the pixels.
(Inherited from RasterImage.)
Public methodSaveCmykPixels Obsolete. (Inherited from RasterImage.)
Public methodCode exampleSavePixels
Saves the pixels.
(Inherited from RasterImage.)
Public methodSaveRawData
Saves the raw data.
(Inherited from RasterImage.)
Public methodCode exampleSetArgb32Pixel
Sets an image 32-bit ARGB pixel for the specified position.
(Inherited from RasterImage.)
Public methodSetPalette
Sets the image palette.
(Inherited from RasterImage.)
Public methodCode exampleSetPixel
Sets an image pixel for the specified position.
(Inherited from RasterImage.)
Public methodCode exampleSetResolution
Sets the resolution for this RasterImage.
(Overrides RasterImageSetResolution(Double, Double).)
Public methodCode exampleToBitmap
Converts raster image to the bitmap.
(Overrides RasterImageToBitmap.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteArgb32ScanLine
Writes the whole scan line to the specified scan line index.
(Inherited from RasterImage.)
Public methodWriteScanLine
Writes the whole scan line to the specified scan line index.
(Inherited from RasterImage.)
Examples
The following example shows how to create a BMP image of the specified size.
[C#]

string dir = "c:\\temp\\";

// Create a BMP image 100 x 100 px.
using (Aspose.Imaging.FileFormats.Bmp.BmpImage bmpImage = new Aspose.Imaging.FileFormats.Bmp.BmpImage(100, 100))
{
    // Fill the image with a simple linear red-black gradient.
    int width = bmpImage.Width;
    int height = bmpImage.Height;
    for (int y = 0; y < height; y++)
    {
        for (int x = 0; x < width; x++)
        {
            int hue = (255 * x) / width;
            bmpImage.SetPixel(x, y, Aspose.Imaging.Color.FromArgb(255, hue, 0, 0));
        }
    }

    using (System.IO.FileStream stream = new System.IO.FileStream(dir + "output.bmp", System.IO.FileMode.Create))
    {
        bmpImage.Save(stream);
    }
}
See Also