Class BmpDecoder

Namespace

SixLabors.ImageSharp.Formats.Bmp

Assembly

SixLabors.ImageSharp.dll

Image decoder for generating an image out of a Windows bitmap stream.

public sealed class BmpDecoder : SpecializedImageDecoder<BmpDecoderOptions>, ISpecializedImageDecoder<BmpDecoderOptions>, IImageDecoder

Inheritance

object

ImageDecoder

SpecializedImageDecoder<BmpDecoderOptions>

BmpDecoder

Implements

ISpecializedImageDecoder<BmpDecoderOptions>

IImageDecoder

Inherited Members

SpecializedImageDecoder<BmpDecoderOptions>.Decode<TPixel>(BmpDecoderOptions, Stream)

SpecializedImageDecoder<BmpDecoderOptions>.Decode(BmpDecoderOptions, Stream)

SpecializedImageDecoder<BmpDecoderOptions>.DecodeAsync<TPixel>(BmpDecoderOptions, Stream, CancellationToken)

SpecializedImageDecoder<BmpDecoderOptions>.DecodeAsync(BmpDecoderOptions, Stream, CancellationToken)

ImageDecoder.Decode<TPixel>(DecoderOptions, Stream)

ImageDecoder.Decode(DecoderOptions, Stream)

ImageDecoder.DecodeAsync<TPixel>(DecoderOptions, Stream, CancellationToken)

ImageDecoder.DecodeAsync(DecoderOptions, Stream, CancellationToken)

ImageDecoder.Identify(DecoderOptions, Stream)

ImageDecoder.IdentifyAsync(DecoderOptions, Stream, CancellationToken)

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Instance

Gets the shared instance.

public static BmpDecoder Instance { get; }

Property Value

BmpDecoder

Methods

CreateDefaultSpecializedOptions(DecoderOptions)

protected override BmpDecoderOptions CreateDefaultSpecializedOptions(DecoderOptions options)

Parameters

options DecoderOptions

Returns

BmpDecoderOptions

Decode(BmpDecoderOptions, Stream, CancellationToken)

protected override Image Decode(BmpDecoderOptions options, Stream stream, CancellationToken cancellationToken)

Parameters

options BmpDecoderOptions

stream Stream

cancellationToken CancellationToken

Returns

Image

Decode<TPixel>(BmpDecoderOptions, Stream, CancellationToken)

protected override Image<TPixel> Decode<TPixel>(BmpDecoderOptions options, Stream stream, CancellationToken cancellationToken) where TPixel : unmanaged, IPixel<TPixel>

Parameters

options BmpDecoderOptions

stream Stream

cancellationToken CancellationToken

Returns

Image<TPixel>

Type Parameters

TPixel

Identify(DecoderOptions, Stream, CancellationToken)

protected override ImageInfo Identify(DecoderOptions options, Stream stream, CancellationToken cancellationToken)

Parameters

options DecoderOptions

stream Stream

cancellationToken CancellationToken

Returns

ImageInfo