Class TiffEncoder

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

Inheritance

Object

TiffEncoder

Implements

IImageEncoder

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

Assembly: SixLabors.ImageSharp.dll

Syntax

public class TiffEncoder : IImageEncoder

Properties

| Improve this Doc View Source

BitsPerPixel

Declaration

public TiffBitsPerPixel? BitsPerPixel { get; set; }

Property Value

Type	Description
Nullable<TiffBitsPerPixel>

| Improve this Doc View Source

Compression

Declaration

public TiffCompression? Compression { get; set; }

Property Value

Type	Description
Nullable<TiffCompression>

| Improve this Doc View Source

CompressionLevel

Declaration

public DeflateCompressionLevel? CompressionLevel { get; set; }

Property Value

Type	Description
Nullable<DeflateCompressionLevel>

| Improve this Doc View Source

HorizontalPredictor

Declaration

public TiffPredictor? HorizontalPredictor { get; set; }

Property Value

Type	Description
Nullable<TiffPredictor>

| Improve this Doc View Source

PhotometricInterpretation

Declaration

public TiffPhotometricInterpretation? PhotometricInterpretation { get; set; }

Property Value

Type	Description
Nullable<TiffPhotometricInterpretation>

| Improve this Doc View Source

Quantizer

Declaration

public IQuantizer Quantizer { get; set; }

Property Value

Type	Description
IQuantizer

Methods

| Improve this Doc View Source

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

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

Declaration

public void Encode<TPixel>(Image<TPixel> image, Stream stream)
    where TPixel : struct, 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.

Type Parameters

Name	Description
TPixel	The pixel format.

| Improve this Doc View Source

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

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

Declaration

public Task EncodeAsync<TPixel>(Image<TPixel> image, Stream stream, CancellationToken cancellationToken)
    where TPixel : struct, 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.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Type Parameters

Name	Description
TPixel	The pixel format.

Implements

IImageEncoder