Class TiffEncoder

Encoder for writing the data image to a stream in TIFF format.

Inheritance

object

ImageEncoder

QuantizingImageEncoder

TiffEncoder

Implements

IImageEncoder

Inherited Members

QuantizingImageEncoder.Quantizer

QuantizingImageEncoder.PixelSamplingStrategy

ImageEncoder.SkipMetadata

ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream)

ImageEncoder.EncodeAsync<TPixel>(Image<TPixel>, Stream, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Formats.Tiff

Assembly: SixLabors.ImageSharp.dll

Syntax

public class TiffEncoder : QuantizingImageEncoder, IImageEncoder

Constructors

TiffEncoder()

Initializes a new instance of the TiffEncoder class.

Declaration

public TiffEncoder()

Properties

BitsPerPixel

Gets the number of bits per pixel.

Declaration

public TiffBitsPerPixel? BitsPerPixel { get; init; }

Property Value

Type	Description
TiffBitsPerPixel?

Compression

Gets the compression type to use.

Declaration

public TiffCompression? Compression { get; init; }

Property Value

Type	Description
TiffCompression?

CompressionLevel

Gets the compression level 1-9 for the deflate compression mode. Defaults to DefaultCompression.

Declaration

public DeflateCompressionLevel? CompressionLevel { get; init; }

Property Value

Type	Description
DeflateCompressionLevel?

HorizontalPredictor

Gets a value indicating which horizontal prediction to use. This can improve the compression ratio with deflate or lzw compression.

Declaration

public TiffPredictor? HorizontalPredictor { get; init; }

Property Value

Type	Description
TiffPredictor?

PhotometricInterpretation

Gets the PhotometricInterpretation to use. Possible options are RGB, RGB with a color palette, gray or BiColor. If no PhotometricInterpretation is specified or it is unsupported by the encoder, RGB will be used.

Declaration

public TiffPhotometricInterpretation? PhotometricInterpretation { get; init; }

Property Value

Type	Description
TiffPhotometricInterpretation?

Methods

Encode<TPixel>(Image<TPixel>, Stream, CancellationToken)

Encodes the image to the specified stream from the Image<TPixel>.

Declaration

protected override void Encode<TPixel>(Image<TPixel> image, Stream stream, CancellationToken cancellationToken) where TPixel : unmanaged, IPixel<TPixel>

Parameters

Type	Name	Description
Image<TPixel>	image	The Image<TPixel> to encode from.
Stream	stream	The Stream to encode the image data to.
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Type Parameters

Name	Description
TPixel	The pixel format.

Overrides

ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream, CancellationToken)

Remarks

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

Implements

IImageEncoder