Class JpegDecoder

Namespace

SixLabors.ImageSharp.Formats.Jpeg

Assembly

SixLabors.ImageSharp.dll

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

public sealed class JpegDecoder : SpecializedImageDecoder<JpegDecoderOptions>, ISpecializedImageDecoder<JpegDecoderOptions>, IImageDecoder

Inheritance

object

ImageDecoder

SpecializedImageDecoder<JpegDecoderOptions>

JpegDecoder

Implements

ISpecializedImageDecoder<JpegDecoderOptions>

IImageDecoder

Inherited Members

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

SpecializedImageDecoder<JpegDecoderOptions>.Decode(JpegDecoderOptions, Stream)

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

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

Property Value

JpegDecoder

Methods

CreateDefaultSpecializedOptions(DecoderOptions)

A factory method for creating the default specialized options.

protected override JpegDecoderOptions CreateDefaultSpecializedOptions(DecoderOptions options)

Parameters

options DecoderOptions

The general decoder options.

Returns

JpegDecoderOptions

The new JpegDecoderOptions.

Decode(JpegDecoderOptions, Stream, CancellationToken)

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

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

Parameters

options JpegDecoderOptions

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>(JpegDecoderOptions, Stream, CancellationToken)

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

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

Parameters

options JpegDecoderOptions

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.