BmpEncoder Class

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

Inheritance Hierarchy

SystemObject
Atalasoft.Imaging.CodecImageEncoder
Atalasoft.Imaging.CodecBmpEncoder

Namespace: Atalasoft.Imaging.Codec
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

public class BmpEncoder : ImageEncoder

Public Class BmpEncoder
	Inherits ImageEncoder

The BmpEncoder type exposes the following members.

Constructors

	Name	Description
	BmpEncoder	Initializes a new instance of a BmpEncoder.
	BmpEncoder(BmpCompression)	Initializes a new instance of BmpEncoder specifying the compression to use.

Properties

	Name	Description
	Compression	The compression to use when writing Bmp images.
	SupportedPixelFormats	Returns an array of pixel formats supported by this encoder. (Overrides ImageEncoderSupportedPixelFormats.)

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsPixelFormatSupported	Returns true if the given PixelFormat can be encoded with the derived encoder. (Inherited from ImageEncoder.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Save	Encode an AtalaImage as a Bmp image to a stream. (Overrides ImageEncoderSave(Stream, AtalaImage, ProgressEventHandler).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Remarks

This ImageEncoder can be passed into the the AtalaImage or Workspace objects when saving to specify a BMP image.

Examples

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