Class BmpEncoder

Image encoder for writing an image to a stream as a Windows bitmap.

Inheritance

Object

BmpEncoder

Implements

IImageEncoder

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: SixLabors.ImageSharp.Formats.Bmp

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class BmpEncoder : IImageEncoder

Properties

| Improve this Doc View Source

BitsPerPixel

Gets or sets the number of bits per pixel.

Declaration

public BmpBitsPerPixel? BitsPerPixel { get; set; }

Property Value

Type	Description
Nullable<BmpBitsPerPixel>

| Improve this Doc View Source

Quantizer

Gets or sets the quantizer for reducing the color count for 8-Bit images. Defaults to OctreeQuantizer.

Declaration

public IQuantizer Quantizer { get; set; }

Property Value

Type	Description
IQuantizer

| Improve this Doc View Source

SupportTransparency

Gets or sets a value indicating whether the encoder should support transparency. Note: Transparency support only works together with 32 bits per pixel. This option will change the default behavior of the encoder of writing a bitmap version 3 info header with no compression. Instead a bitmap version 4 info header will be written with the BITFIELDS compression.

Declaration

public bool SupportTransparency { get; set; }

Property Value

Type	Description
Boolean

Methods

| Improve this Doc View Source

Encode<TPixel>(Image<TPixel>, Stream)

Encodes the image to the specified stream from the Image<TPixel>.

Declaration

public void Encode<TPixel>(Image<TPixel> image, Stream stream)
    where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
Image<TPixel>	image	The Image<TPixel> to encode from.
Stream	stream	The Stream to encode the image data to.

Type Parameters

Name	Description
TPixel	The pixel format.

| Improve this Doc View Source

EncodeAsync<TPixel>(Image<TPixel>, Stream, CancellationToken)

Encodes the image to the specified stream from the Image<TPixel>.

Declaration

public Task EncodeAsync<TPixel>(Image<TPixel> image, Stream stream, CancellationToken cancellationToken)
    where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
Image<TPixel>	image	The Image<TPixel> to encode from.
Stream	stream	The Stream to encode the image data to.
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Type Parameters

Name	Description
TPixel	The pixel format.

Implements

IImageEncoder