BmpImage

BmpImage class

A bmp image (supports BMP, DIB formats).

public sealed class BmpImage : RasterCachedImage

Constructors

Name Description
BmpImage(RasterImage) Initializes a new instance of the BmpImage class.
BmpImage(Stream) Initializes a new instance of the BmpImage class.
BmpImage(string) Initializes a new instance of the BmpImage class.
BmpImage(int, int) Initializes a new instance of the BmpImage class.
BmpImage(int, int, ushort, IColorPalette) Initializes a new instance of the BmpImage class.
BmpImage(RasterImage, ushort, BitmapCompression, double, double) Initializes a new instance of the BmpImage class.
BmpImage(Stream, ushort, BitmapCompression, double, double) Initializes a new instance of the BmpImage class.
BmpImage(string, ushort, BitmapCompression, double, double) Initializes a new instance of the BmpImage class.
BmpImage(int, int, ushort, IColorPalette, BitmapCompression, double, double) Initializes a new instance of the BmpImage class.

Properties

Name Description
AutoAdjustPalette { get; set; } Gets or sets a value indicating whether automatic adjust palette.
virtual BackgroundColor { get; set; } Gets or sets a value for the background color.
BitmapInfoHeader { get; } Gets the bitmap information header.
override BitsPerPixel { get; } Gets the image bits per pixel count.
Bounds { get; } Gets the image bounds.
BufferSizeHint { get; set; } Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
Compression { get; } Gets the image compression.
Container { get; } Gets the Image container.
DataStreamContainer { get; } Gets the object’s data stream.
Disposed { get; } Gets a value indicating whether this instance is disposed.
override FileFormat { get; } Gets a value of file format
virtual HasAlpha { get; } Gets a value indicating whether this instance has alpha.
virtual HasBackgroundColor { get; set; } Gets or sets a value indicating whether image has background color.
virtual HasTransparentColor { get; set; } Gets a value indicating whether image has transparent color.
override Height { get; } Gets the image height.
override HorizontalResolution { get; set; } Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage.
virtual ImageOpacity { get; } Gets opacity of this image.
InterruptMonitor { get; set; } Gets or sets the interrupt monitor.
override IsCached { get; } Gets a value indicating whether image data is cached currently.
IsRawDataAvailable { get; } Gets a value indicating whether raw data loading is available.
Palette { get; set; } Gets or sets the color palette. The color palette is not used when pixels are represented directly.
virtual PremultiplyComponents { get; set; } Gets or sets a value indicating whether the image components must be premultiplied.
RawCustomColorConverter { get; set; } Gets or sets the custom color converter
override RawDataFormat { get; } Gets the raw data format.
RawDataSettings { get; } Gets the current raw data settings. Note when using these settings the data loads without conversion.
RawFallbackIndex { get; set; } Gets or sets the fallback index to use when palette index is out of bounds
RawIndexedColorConverter { get; set; } Gets or sets the indexed color converter
override RawLineSize { get; } Gets the raw line size in bytes.
Size { get; } Gets the image size.
virtual TransparentColor { get; set; } Gets the image transparent color.
virtual UpdateXmpData { get; set; } Gets or sets a value indicating whether to update the XMP metadata.
override UsePalette { get; } Gets a value indicating whether the image palette is used.
virtual UseRawData { get; set; } Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
override VerticalResolution { get; set; } Gets or sets the vertical resolution, in pixels per inch, of this RasterImage.
override Width { get; } Gets the image width.
virtual XmpData { get; set; } Gets or sets the XMP metadata.

Methods

Name Description
override AdjustBrightness(int) Adjust of a brightness for image.
override AdjustContrast(float) Image contrasting
override AdjustGamma(float) Gamma-correction of an image.
override AdjustGamma(float, float, float) Gamma-correction of an image.
override BinarizeBradley(double) Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
override BinarizeBradley(double, int) Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
override BinarizeFixed(byte) Binarization of an image with predefined threshold
override BinarizeOtsu() Binarization of an image with Otsu thresholding
override CacheData() Caches the data and ensures no additional data loading will be performed from the underlying DataStreamContainer.
CanSave(ImageOptionsBase) Determines whether image can be saved to the specified file format represented by the passed save options.
override Crop(Rectangle) Cropping the image.
virtual Crop(int, int, int, int) Crop image with shifts.
Dispose() Disposes the current instance.
Dither(DitheringMethod, int) Performs dithering on the current image.
override Dither(DitheringMethod, int, IColorPalette) Performs dithering on the current image.
virtual Filter(Rectangle, FilterOptionsBase) Filters the specified rectangle.
GetArgb32Pixel(int, int) Gets an image 32-bit ARGB pixel.
GetDefaultArgb32Pixels(Rectangle) Gets the default 32-bit ARGB pixels array.
override GetDefaultOptions(object[]) Gets the default options.
GetDefaultPixels(Rectangle, IPartialArgb32PixelLoader) Gets the default pixels array using partial pixel loader.
GetDefaultRawData(Rectangle, RawDataSettings) Gets the default raw data array.
GetDefaultRawData(Rectangle, IPartialRawDataLoader, RawDataSettings) Gets the default raw data array using partial pixel loader.
virtual GetModifyDate(bool) Gets the date and time the resource image was last modified.
virtual GetOriginalOptions() 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 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 method as the second parameter.
GetPixel(int, int) Gets an image pixel.
GetSkewAngle() Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning.
override Grayscale() Transformation of an image to its grayscale representation
LoadArgb32Pixels(Rectangle) Loads 32-bit ARGB pixels.
LoadArgb64Pixels(Rectangle) Loads 64-bit ARGB pixels.
LoadCmyk32Pixels(Rectangle) Loads pixels in CMYK format.
LoadPartialArgb32Pixels(Rectangle, IPartialArgb32PixelLoader) Loads 32-bit ARGB pixels partially by packs.
LoadPartialPixels(Rectangle, IPartialPixelLoader) Loads pixels partially by packs.
LoadPixels(Rectangle) Loads pixels.
LoadRawData(Rectangle, RawDataSettings, IPartialRawDataLoader) Loads raw data.
LoadRawData(Rectangle, Rectangle, RawDataSettings, IPartialRawDataLoader) Loads raw data.
NormalizeAngle() Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate methods.
virtual NormalizeAngle(bool, 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 methods.
ReadArgb32ScanLine(int) Reads the whole scan line by the specified scan line index.
ReadScanLine(int) Reads the whole scan line by the specified scan line index.
ReplaceColor(Color, byte, Color) Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
virtual ReplaceColor(int, byte, int) Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
ReplaceNonTransparentColors(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.
virtual ReplaceNonTransparentColors(int) 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.
Resize(int, int) Resizes the image. The default NearestNeighbourResample is used.
override Resize(int, int, ImageResizeSettings) Resizes the image.
override Resize(int, int, ResizeType) Resizes the image.
ResizeHeightProportionally(int) Resizes the height proportionally. The default NearestNeighbourResample is used.
virtual ResizeHeightProportionally(int, ImageResizeSettings) Resizes the height proportionally.
virtual ResizeHeightProportionally(int, ResizeType) Resizes the height proportionally.
ResizeWidthProportionally(int) Resizes the width proportionally. The default NearestNeighbourResample is used.
virtual ResizeWidthProportionally(int, ImageResizeSettings) Resizes the width proportionally.
virtual ResizeWidthProportionally(int, ResizeType) Resizes the width proportionally.
virtual Rotate(float) Rotate image around the center.
override Rotate(float, bool, Color) Rotate image around the center.
override RotateFlip(RotateFlipType) Rotates, flips, or rotates and flips the image.
Save() Saves the image data to the underlying stream.
Save(Stream) Saves the object’s data to the specified stream.
override Save(string) Saves the image to the specified file location.
Save(Stream, ImageOptionsBase) Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, bool) Saves the object’s data to the specified file location.
virtual Save(string, ImageOptionsBase) Saves the object’s data to the specified file location in the specified file format according to save options.
override Save(Stream, ImageOptionsBase, Rectangle) Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, ImageOptionsBase, Rectangle) Saves the object’s data to the specified file location in the specified file format according to save options.
SaveArgb32Pixels(Rectangle, int[]) Saves the 32-bit ARGB pixels.
SaveCmyk32Pixels(Rectangle, int[]) Saves the pixels.
SavePixels(Rectangle, Color[]) Saves the pixels.
SaveRawData(byte[], int, Rectangle, RawDataSettings) Saves the raw data.
SetArgb32Pixel(int, int, int) Sets an image 32-bit ARGB pixel for the specified position.
override SetPalette(IColorPalette, bool) Sets the image palette.
SetPixel(int, int, Color) Sets an image pixel for the specified position.
override SetResolution(double, double) Sets the resolution for this RasterImage.
override ToBitmap() Converts raster image to the bitmap.
WriteArgb32ScanLine(int, int[]) Writes the whole scan line to the specified scan line index.
WriteScanLine(int, Color[]) Writes the whole scan line to the specified scan line index.

Examples

Decompress BMP image which was previously compressed using DXT1 compression algorithm.

[C#]

using (var image = Image.Load("CompressedTiger.bmp"))
{
    image.Save("DecompressedTiger.bmp", new BmpOptions());
}

Compress BMP image using DXT1 compression algorithm.

[C#]

using (var image = Image.Load("Tiger.bmp"))
{
    image.Save("CompressedTiger.bmp", new BmpOptions { Compression = BitmapCompression.Dxt1 });
}

The example shows how to export a BmpImage with the Rgb compression type.

[C#]

string sourcePath = "input.png";
// Load a PNG image from a file.
using (Image pngImage = Image.Load(sourcePath))
{
    // BMP image is saved with transparency support by default, that is achieved by using the BitmapCompression.Bitfields compression method. 
    // To save a BMP image with the Rgb compression method, the BmpOptions with the Compression property set to BitmapCompression.Rgb should be specified.
    pngImage.Save(outputPath, new BmpOptions() { Compression = BitmapCompression.Rgb });
}

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);
    }
}

The example shows how to export a BmpImage from a Png file while keeping the alpha channel, save a Bmp file with transparency.

[C#]

string sourcePath = "input.png";
// Load a PNG image from a file.
using (Image pngImage = Image.Load(sourcePath))
{
    // BMP image is saved with transparency support by default. 
    // If you want to explicitly specify such mode, the BmpOptions's Compression property should be set to BitmapCompression.Bitfields.
    // The BitmapCompression.Bitfields compression method is the default compression method in the BmpOptions.
    // So the same result of exporting a Bmp image with transparency can be achieved by either one of the following ways.
    // With an implicit default options:
    pngImage.Save(outputPath);
    // With an explicit default options:
    pngImage.Save(outputPath, new BmpOptions());
    // Specifying the BitmapCompression.Bitfields compression method:
    pngImage.Save(outputPath, new BmpOptions() { Compression = BitmapCompression.Bitfields });
}

See Also