Interface IImageEncoder
Encapsulates properties and methods required for encoding an image to a stream.
Namespace: SixLabors.ImageSharp.Formats
Assembly: SixLabors.ImageSharp.dll
Syntax
public interface IImageEncoderMethods
| Improve this Doc View SourceEncode<TPixel>(Image<TPixel>, Stream)
Encodes the image to the specified stream from the Image<TPixel>.
Declaration
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. |
EncodeAsync<TPixel>(Image<TPixel>, Stream, CancellationToken)
Encodes the image to the specified stream from the Image<TPixel>.
Declaration
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. |