Class WebpEncoder

Image encoder for writing an image to a stream in the Webp format.

Inheritance

Object

WebpEncoder

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

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class WebpEncoder : IImageEncoder

Properties

| Improve this Doc View Source

EntropyPasses

Declaration

public int EntropyPasses { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

FileFormat

Declaration

public WebpFileFormatType? FileFormat { get; set; }

Property Value

Type	Description
Nullable<WebpFileFormatType>

| Improve this Doc View Source

FilterStrength

Declaration

public int FilterStrength { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Method

Declaration

public WebpEncodingMethod Method { get; set; }

Property Value

Type	Description
WebpEncodingMethod

| Improve this Doc View Source

NearLossless

Declaration

public bool NearLossless { get; set; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

NearLosslessQuality

Declaration

public int NearLosslessQuality { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Quality

Declaration

public int Quality { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

SpatialNoiseShaping

Declaration

public int SpatialNoiseShaping { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

TransparentColorMode

Declaration

public WebpTransparentColorMode TransparentColorMode { get; set; }

Property Value

Type	Description
WebpTransparentColorMode

| Improve this Doc View Source

UseAlphaCompression

Declaration

public bool UseAlphaCompression { get; set; }

Property Value

Type	Description
Boolean

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