Class PngDecoder

Namespace

SixLabors.ImageSharp.Formats.Png

Assembly

SixLabors.ImageSharp.dll

Decoder for generating an image out of a png encoded stream.

public sealed class PngDecoder : SpecializedImageDecoder<PngDecoderOptions>, ISpecializedImageDecoder<PngDecoderOptions>, IImageDecoder

Inheritance

object

ImageDecoder

SpecializedImageDecoder<PngDecoderOptions>

PngDecoder

Implements

ISpecializedImageDecoder<PngDecoderOptions>

IImageDecoder

Inherited Members

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

SpecializedImageDecoder<PngDecoderOptions>.Decode(PngDecoderOptions, Stream)

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

SpecializedImageDecoder<PngDecoderOptions>.DecodeAsync(PngDecoderOptions, 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 PngDecoder Instance { get; }

Property Value

PngDecoder

Methods

CreateDefaultSpecializedOptions(DecoderOptions)

A factory method for creating the default specialized options.

protected override PngDecoderOptions CreateDefaultSpecializedOptions(DecoderOptions options)

Parameters

options DecoderOptions

The general decoder options.

Returns

PngDecoderOptions

The new PngDecoderOptions.

Decode(PngDecoderOptions, Stream, CancellationToken)

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

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

Parameters

options PngDecoderOptions

The specialized decoder options.

stream Stream

The Stream containing image data.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Image

The Image<TPixel>.

Remarks

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

Exceptions

ImageFormatException

Thrown if the encoded image contains errors.

Decode<TPixel>(PngDecoderOptions, Stream, CancellationToken)

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

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

Parameters

options PngDecoderOptions

The specialized decoder options.

stream Stream

The Stream containing image data.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Image<TPixel>

The Image<TPixel>.

Type Parameters

TPixel

The pixel format.

Remarks

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

Exceptions

ImageFormatException

Thrown if the encoded image contains errors.

Identify(DecoderOptions, Stream, CancellationToken)

Reads the raw image information from the specified stream.

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

Parameters

options DecoderOptions

The general decoder options.

stream Stream

The Stream containing image data.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

ImageInfo

The ImageInfo object.

Remarks

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

Exceptions

ImageFormatException

Thrown if the encoded image contains errors.