Click or drag to resize

BmpEncoder Class

An ImageEncoder that will write Windows Bitmap (BMP) images to a Stream.

Inheritance Hierarchy

Namespace:  Atalasoft.Imaging.Codec
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: (.NET 4.5.2, x86)
public class BmpEncoder : ImageEncoder

The BmpEncoder type exposes the following members.

Public methodBmpEncoder
Initializes a new instance of a BmpEncoder.
Public methodBmpEncoder(BmpCompression)
Initializes a new instance of BmpEncoder specifying the compression to use.
Public propertyCompression
The compression to use when writing Bmp images.
Public propertySupportedPixelFormats
Returns an array of pixel formats supported by this encoder.
(Overrides ImageEncoderSupportedPixelFormats.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsPixelFormatSupported
Returns true if the given PixelFormat can be encoded with the derived encoder.
(Inherited from ImageEncoder.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSave
Encode an AtalaImage as a Bmp image to a stream.
(Overrides ImageEncoderSave(Stream, AtalaImage, ProgressEventHandler).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
This ImageEncoder can be passed into the the AtalaImage or Workspace objects when saving to specify a BMP image.

This example demonstrates how to save the current image in a workspace to a Bmp file.

Saving a Bmp Image (Visual Basic)
myWorkspace.Save("c:\image.bmp", New BmpEncoder())
Saving a Bmp Image (C#)
myWorkspace.Save("c:\\image.bmp", new BmpEncoder());
See Also