Class BmpDecoder
Image decoder for generating an image out of a Windows bitmap stream.
Inherited Members
Namespace: SixLabors.ImageSharp.Formats.Bmp
Assembly: SixLabors.ImageSharp.dll
Syntax
public sealed class BmpDecoder : IImageDecoder, IBmpDecoderOptions, IImageInfoDetectorRemarks
Does not support the following formats at the moment:
Properties
| Improve this Doc View Source
RleSkippedPixelHandling
Gets or sets a value indicating how to deal with skipped pixels, which can occur during decoding run length encoded bitmaps.
Declaration
public RleSkippedPixelHandling RleSkippedPixelHandling { get; set; }Property Value
| Type | Description |
|---|---|
| RleSkippedPixelHandling |
Methods
| Improve this Doc View Source%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A){kind=link}
Decode(Configuration, Stream)
Decodes the image from the specified stream to an Image.
Declaration
public Image Decode(Configuration configuration, Stream stream)Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | The configuration for the image. |
| Stream | stream | The Stream containing image data. |
Returns
| Type | Description |
|---|---|
| Image | The Image. |
%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A){kind=link}
Decode<TPixel>(Configuration, Stream)
Decodes the image from the specified stream to an Image<TPixel> of a specific pixel type.
Declaration
public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
where TPixel : struct, IPixel<TPixel>Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | The configuration for the image. |
| Stream | stream | The Stream containing image data. |
Returns
| Type | Description |
|---|---|
| Image<TPixel> | The Image<TPixel>. |
Type Parameters
| Name | Description |
|---|---|
| TPixel | The pixel format. |
%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A){kind=link}
DecodeAsync(Configuration, Stream, CancellationToken)
Decodes the image from the specified stream to an Image.
Declaration
public async Task<Image> DecodeAsync(Configuration configuration, Stream stream, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | The configuration for the image. |
| Stream | stream | The Stream containing image data. |
| CancellationToken | cancellationToken | The token to monitor for cancellation requests. |
Returns
| Type | Description |
|---|---|
| Task<Image> | The Image. |
%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A){kind=link}
DecodeAsync<TPixel>(Configuration, Stream, CancellationToken)
Decodes the image from the specified stream to an Image<TPixel> of a specific pixel type.
Declaration
public Task<Image<TPixel>> DecodeAsync<TPixel>(Configuration configuration, Stream stream, CancellationToken cancellationToken)
where TPixel : struct, IPixel<TPixel>Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | The configuration for the image. |
| Stream | stream | The Stream containing image data. |
| CancellationToken | cancellationToken | The token to monitor for cancellation requests. |
Returns
| Type | Description |
|---|---|
| Task<Image<TPixel>> | The Image<TPixel>. |
Type Parameters
| Name | Description |
|---|---|
| TPixel | The pixel format. |
%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A){kind=link}
Identify(Configuration, Stream)
Reads the raw image information from the specified stream.
Declaration
public IImageInfo Identify(Configuration configuration, Stream stream)Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | The configuration for the image. |
| Stream | stream | The Stream containing image data. |
Returns
| Type | Description |
|---|---|
| IImageInfo | The PixelTypeInfo object |
%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A){kind=link}
IdentifyAsync(Configuration, Stream, CancellationToken)
Reads the raw image information from the specified stream.
Declaration
public Task<IImageInfo> IdentifyAsync(Configuration configuration, Stream stream, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | The configuration for the image. |
| Stream | stream | The Stream containing image data. |
| CancellationToken | cancellationToken | The token to monitor for cancellation requests. |
Returns
| Type | Description |
|---|---|
| Task<IImageInfo> | The PixelTypeInfo object |
