Class SpecializedImageDecoder<T>

Acts as a base class for specialized image decoders. Specialized decoders allow for additional options to be passed to the decoder. Types that inherit this decoder are required to implement cancellable synchronous decoding operations only.

Inheritance

Object

ImageDecoder

SpecializedImageDecoder<T>

BmpDecoder

JpegDecoder

Implements

ISpecializedImageDecoder<T>

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)

ImageDecoder.Identify(DecoderOptions, Stream, CancellationToken)

ImageDecoder.ScaleToTargetSize(DecoderOptions, Image)

Namespace: SixLabors.ImageSharp.Formats

Assembly: SixLabors.ImageSharp.dll

Syntax

public abstract class SpecializedImageDecoder<T> : ImageDecoder, ISpecializedImageDecoder<T>, IImageDecoder where T : ISpecializedDecoderOptions

Type Parameters

Name	Description
T	The type of specialized options.

Methods

| Improve this Doc View Source

CreateDefaultSpecializedOptions(DecoderOptions)

A factory method for creating the default specialized options.

Declaration

protected abstract T CreateDefaultSpecializedOptions(DecoderOptions options)

Parameters

Type	Name	Description
DecoderOptions	options	The general decoder options.

Returns

Type	Description
T	The new `T`.

| Improve this Doc View Source

Decode(T, Stream)

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

Declaration

public Image Decode(T options, Stream stream)

Parameters

Type	Name	Description
T	options	The specialized decoder options.
Stream	stream	The containing image data.

Returns

Type	Description
Image	The Image<TPixel>.

Exceptions

Type	Condition
ImageFormatException	Thrown if the encoded image contains errors.

| Improve this Doc View Source

Decode(T, Stream, CancellationToken)

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

Declaration

protected abstract Image Decode(T options, Stream stream, CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Image	The Image<TPixel>.

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.

| Improve this Doc View Source

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

| Improve this Doc View Source

Decode<TPixel>(T, Stream)

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

Declaration

public Image<TPixel> Decode<TPixel>(T options, Stream stream)
    where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
T	options	The specialized decoder options.
Stream	stream	The containing image data.

Returns

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

Type Parameters

Name	Description
TPixel	The pixel format.

Exceptions

Type	Condition
ImageFormatException	Thrown if the encoded image contains errors.

| Improve this Doc View Source

Decode<TPixel>(T, Stream, CancellationToken)

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

Declaration

protected abstract Image<TPixel> Decode<TPixel>(T options, Stream stream, CancellationToken cancellationToken)
    where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
T	options	The specialized decoder options.
Stream	stream	The 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.

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.

| Improve this Doc View Source

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 : struct, IPixel<TPixel>

Parameters

Type	Name	Description
DecoderOptions	options	The general decoder options.
Stream	stream	The 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.

| Improve this Doc View Source

DecodeAsync(T, Stream, CancellationToken)

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

Declaration

public async Task<Image> DecodeAsync(T options, Stream stream, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
Task<Image>	A representing the asynchronous operation.

Exceptions

Type	Condition
ImageFormatException	Thrown if the encoded image contains errors.

| Improve this Doc View Source

DecodeAsync<TPixel>(T, Stream, CancellationToken)

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

Declaration

public async Task<Image<TPixel>> DecodeAsync<TPixel>(T options, Stream stream, CancellationToken cancellationToken = null)
    where TPixel : struct, IPixel<TPixel>

Parameters

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

Returns

Type	Description
Task<Image<TPixel>>	A representing the asynchronous operation.

Type Parameters

Name	Description
TPixel	The pixel format.

Exceptions

Type	Condition
ImageFormatException	Thrown if the encoded image contains errors.

Implements

ISpecializedImageDecoder<T>

IImageDecoder