Class PbmDecoder

Image decoder for reading PGM, PBM or PPM bitmaps from a stream. These images are from the family of PNM images.

• PBMBlack and white images.
• PGMGrayscale images.
• PPMColor images, with RGB pixels.

The specification of these images is found at http://netpbm.sourceforge.net/doc/pnm.html.

Inheritance

object

ImageDecoder

PbmDecoder

Implements

IImageDecoder

Inherited Members

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.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Formats.Pbm

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class PbmDecoder : ImageDecoder, IImageDecoder

Properties

Instance

Gets the shared instance.

Declaration

public static PbmDecoder Instance { get; }

Property Value

Type	Description
PbmDecoder

Methods

Decode(DecoderOptions, Stream, CancellationToken)

Decodes the image from the specified stream to an Image.

Declaration

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

Parameters

Type	Name	Description
DecoderOptions	options	The general decoder options.
Stream	stream	The Stream containing image data.
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Image	The Image.

Overrides

ImageDecoder.Decode(DecoderOptions, Stream, CancellationToken)

Remarks

This method is designed to support the ImageSharp internal infrastructure and is not recommended for direct use.

Exceptions

Type	Condition
ImageFormatException	Thrown if the encoded image contains errors.

Decode<TPixel>(DecoderOptions, Stream, CancellationToken)

Decodes the image from the specified stream to an Image<TPixel> of a specific pixel type.

Declaration

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

Parameters

Type	Name	Description
DecoderOptions	options	The general decoder options.
Stream	stream	The Stream containing image data.
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Image<TPixel>	The Image<TPixel>.

Type Parameters

Name	Description
TPixel	The pixel format.

Overrides

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

Remarks

This method is designed to support the ImageSharp internal infrastructure and is not recommended for direct use.

Exceptions

Type	Condition
ImageFormatException	Thrown if the encoded image contains errors.

Identify(DecoderOptions, Stream, CancellationToken)

Reads the raw image information from the specified stream.

Declaration

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

Parameters

Type	Name	Description
DecoderOptions	options	The general decoder options.
Stream	stream	The Stream containing image data.
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
ImageInfo	The ImageInfo object.

Overrides

ImageDecoder.Identify(DecoderOptions, Stream, CancellationToken)

Remarks

This method is designed to support the ImageSharp internal infrastructure and is not recommended for direct use.

Exceptions

Type	Condition
ImageFormatException	Thrown if the encoded image contains errors.

Implements

IImageDecoder