Class JpegEncoder

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

Inheritance
Object
JpegEncoder
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Formats.Jpeg
Assembly: SixLabors.ImageSharp.dll
Syntax
public sealed class JpegEncoder : IImageEncoder

Properties

| Improve this Doc View Source

Quality

Gets or sets the quality, that will be used to encode the image. Quality index must be between 0 and 100 (compression from max to min). Defaults to 75.

Declaration
public int? Quality { get; set; }
Property Value
Type Description
Nullable<Int32>
| Improve this Doc View Source

Subsample

Gets or sets the subsample ration, that will be used to encode the image.

Declaration
public JpegSubsample? Subsample { get; set; }
Property Value
Type Description
Nullable<JpegSubsample>

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