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

PbmDecoder

Implements

IImageDecoder

IImageInfoDetector

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.Pbm

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class PbmDecoder : IImageDecoder, IImageInfoDetector

Methods

Decode(Configuration, Stream, CancellationToken)

Decodes the image from the specified stream to an Image.

Declaration

public Image Decode(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
Image	The Image.

Decode<TPixel>(Configuration, Stream, CancellationToken)

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, 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
Image<TPixel>	The Image<TPixel>.

Type Parameters

Name	Description
TPixel	The pixel format.

Identify(Configuration, Stream, CancellationToken)

Reads the raw image information from the specified stream.

Declaration

public IImageInfo Identify(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
IImageInfo	The PixelTypeInfo object

Implements

IImageDecoder

IImageInfoDetector