Class ImageExtensions

Namespace: SixLabors.ImageSharp

Assembly: SixLabors.ImageSharp.dll

Extension methods for the Image type.

public static class ImageExtensions

Inheritance: object

ImageExtensions

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Save(Image, Stream, IImageFormat)

Writes the image to the given stream using the given image format.

public static void Save(this Image source, Stream stream, IImageFormat format)

Parameters

source Image: The source image.
stream Stream: The stream to save the image to.
format IImageFormat: The format to save the image in.

Exceptions

ArgumentNullException: The stream is null.
ArgumentNullException: The format is null.
NotSupportedException: The stream is not writable.
NotSupportedException: No encoder available for provided format.

Save(Image, string)

Writes the image to the given file path using an encoder detected from the path.

public static void Save(this Image source, string path)

Parameters

source Image: The source image.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: No encoder available for provided path.

Save(Image, string, IImageEncoder)

Writes the image to the given file path using the given image encoder.

public static void Save(this Image source, string path, IImageEncoder encoder)

Parameters

source Image: The source image.
path string: The file path to save the image to.
encoder IImageEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: The path is null.
ArgumentNullException: The encoder is null.

SaveAsBmp(Image, Stream)

Saves the image to the given stream with the Bmp format.

public static void SaveAsBmp(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsBmp(Image, Stream, BmpEncoder)

Saves the image to the given stream with the Bmp format.

public static void SaveAsBmp(this Image source, Stream stream, BmpEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder BmpEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsBmp(Image, string)

Saves the image to the given stream with the Bmp format.

public static void SaveAsBmp(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsBmp(Image, string, BmpEncoder)

Saves the image to the given stream with the Bmp format.

public static void SaveAsBmp(this Image source, string path, BmpEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder BmpEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsBmpAsync(Image, Stream, BmpEncoder, CancellationToken)

Saves the image to the given stream with the Bmp format.

public static Task SaveAsBmpAsync(this Image source, Stream stream, BmpEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder BmpEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsBmpAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Bmp format.

public static Task SaveAsBmpAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsBmpAsync(Image, string)

Saves the image to the given stream with the Bmp format.

public static Task SaveAsBmpAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsBmpAsync(Image, string, BmpEncoder, CancellationToken)

Saves the image to the given stream with the Bmp format.

public static Task SaveAsBmpAsync(this Image source, string path, BmpEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder BmpEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsBmpAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Bmp format.

public static Task SaveAsBmpAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsGif(Image, Stream)

Saves the image to the given stream with the Gif format.

public static void SaveAsGif(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsGif(Image, Stream, GifEncoder)

Saves the image to the given stream with the Gif format.

public static void SaveAsGif(this Image source, Stream stream, GifEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder GifEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsGif(Image, string)

Saves the image to the given stream with the Gif format.

public static void SaveAsGif(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsGif(Image, string, GifEncoder)

Saves the image to the given stream with the Gif format.

public static void SaveAsGif(this Image source, string path, GifEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder GifEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsGifAsync(Image, Stream, GifEncoder, CancellationToken)

Saves the image to the given stream with the Gif format.

public static Task SaveAsGifAsync(this Image source, Stream stream, GifEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder GifEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsGifAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Gif format.

public static Task SaveAsGifAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsGifAsync(Image, string)

Saves the image to the given stream with the Gif format.

public static Task SaveAsGifAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsGifAsync(Image, string, GifEncoder, CancellationToken)

Saves the image to the given stream with the Gif format.

public static Task SaveAsGifAsync(this Image source, string path, GifEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder GifEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsGifAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Gif format.

public static Task SaveAsGifAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsJpeg(Image, Stream)

Saves the image to the given stream with the Jpeg format.

public static void SaveAsJpeg(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsJpeg(Image, Stream, JpegEncoder)

Saves the image to the given stream with the Jpeg format.

public static void SaveAsJpeg(this Image source, Stream stream, JpegEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder JpegEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsJpeg(Image, string)

Saves the image to the given stream with the Jpeg format.

public static void SaveAsJpeg(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsJpeg(Image, string, JpegEncoder)

Saves the image to the given stream with the Jpeg format.

public static void SaveAsJpeg(this Image source, string path, JpegEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder JpegEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsJpegAsync(Image, Stream, JpegEncoder, CancellationToken)

Saves the image to the given stream with the Jpeg format.

public static Task SaveAsJpegAsync(this Image source, Stream stream, JpegEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder JpegEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsJpegAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Jpeg format.

public static Task SaveAsJpegAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsJpegAsync(Image, string)

Saves the image to the given stream with the Jpeg format.

public static Task SaveAsJpegAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsJpegAsync(Image, string, JpegEncoder, CancellationToken)

Saves the image to the given stream with the Jpeg format.

public static Task SaveAsJpegAsync(this Image source, string path, JpegEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder JpegEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsJpegAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Jpeg format.

public static Task SaveAsJpegAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPbm(Image, Stream)

Saves the image to the given stream with the Pbm format.

public static void SaveAsPbm(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPbm(Image, Stream, PbmEncoder)

Saves the image to the given stream with the Pbm format.

public static void SaveAsPbm(this Image source, Stream stream, PbmEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder PbmEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPbm(Image, string)

Saves the image to the given stream with the Pbm format.

public static void SaveAsPbm(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPbm(Image, string, PbmEncoder)

Saves the image to the given stream with the Pbm format.

public static void SaveAsPbm(this Image source, string path, PbmEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder PbmEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPbmAsync(Image, Stream, PbmEncoder, CancellationToken)

Saves the image to the given stream with the Pbm format.

public static Task SaveAsPbmAsync(this Image source, Stream stream, PbmEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder PbmEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPbmAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Pbm format.

public static Task SaveAsPbmAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPbmAsync(Image, string)

Saves the image to the given stream with the Pbm format.

public static Task SaveAsPbmAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPbmAsync(Image, string, PbmEncoder, CancellationToken)

Saves the image to the given stream with the Pbm format.

public static Task SaveAsPbmAsync(this Image source, string path, PbmEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder PbmEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPbmAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Pbm format.

public static Task SaveAsPbmAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPng(Image, Stream)

Saves the image to the given stream with the Png format.

public static void SaveAsPng(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPng(Image, Stream, PngEncoder)

Saves the image to the given stream with the Png format.

public static void SaveAsPng(this Image source, Stream stream, PngEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder PngEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPng(Image, string)

Saves the image to the given stream with the Png format.

public static void SaveAsPng(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPng(Image, string, PngEncoder)

Saves the image to the given stream with the Png format.

public static void SaveAsPng(this Image source, string path, PngEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder PngEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPngAsync(Image, Stream, PngEncoder, CancellationToken)

Saves the image to the given stream with the Png format.

public static Task SaveAsPngAsync(this Image source, Stream stream, PngEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder PngEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPngAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Png format.

public static Task SaveAsPngAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsPngAsync(Image, string)

Saves the image to the given stream with the Png format.

public static Task SaveAsPngAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPngAsync(Image, string, PngEncoder, CancellationToken)

Saves the image to the given stream with the Png format.

public static Task SaveAsPngAsync(this Image source, string path, PngEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder PngEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsPngAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Png format.

public static Task SaveAsPngAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsQoi(Image, Stream)

Saves the image to the given stream with the Qoi format.

public static void SaveAsQoi(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsQoi(Image, Stream, QoiEncoder)

Saves the image to the given stream with the Qoi format.

public static void SaveAsQoi(this Image source, Stream stream, QoiEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder QoiEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsQoi(Image, string)

Saves the image to the given stream with the Qoi format.

public static void SaveAsQoi(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsQoi(Image, string, QoiEncoder)

Saves the image to the given stream with the Qoi format.

public static void SaveAsQoi(this Image source, string path, QoiEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder QoiEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsQoiAsync(Image, Stream, QoiEncoder, CancellationToken)

Saves the image to the given stream with the Qoi format.

public static Task SaveAsQoiAsync(this Image source, Stream stream, QoiEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder QoiEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsQoiAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Qoi format.

public static Task SaveAsQoiAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsQoiAsync(Image, string)

Saves the image to the given stream with the Qoi format.

public static Task SaveAsQoiAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsQoiAsync(Image, string, QoiEncoder, CancellationToken)

Saves the image to the given stream with the Qoi format.

public static Task SaveAsQoiAsync(this Image source, string path, QoiEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder QoiEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsQoiAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Qoi format.

public static Task SaveAsQoiAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTga(Image, Stream)

Saves the image to the given stream with the Tga format.

public static void SaveAsTga(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTga(Image, Stream, TgaEncoder)

Saves the image to the given stream with the Tga format.

public static void SaveAsTga(this Image source, Stream stream, TgaEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder TgaEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTga(Image, string)

Saves the image to the given stream with the Tga format.

public static void SaveAsTga(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTga(Image, string, TgaEncoder)

Saves the image to the given stream with the Tga format.

public static void SaveAsTga(this Image source, string path, TgaEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder TgaEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTgaAsync(Image, Stream, TgaEncoder, CancellationToken)

Saves the image to the given stream with the Tga format.

public static Task SaveAsTgaAsync(this Image source, Stream stream, TgaEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder TgaEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTgaAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Tga format.

public static Task SaveAsTgaAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTgaAsync(Image, string)

Saves the image to the given stream with the Tga format.

public static Task SaveAsTgaAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTgaAsync(Image, string, TgaEncoder, CancellationToken)

Saves the image to the given stream with the Tga format.

public static Task SaveAsTgaAsync(this Image source, string path, TgaEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder TgaEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTgaAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Tga format.

public static Task SaveAsTgaAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTiff(Image, Stream)

Saves the image to the given stream with the Tiff format.

public static void SaveAsTiff(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTiff(Image, Stream, TiffEncoder)

Saves the image to the given stream with the Tiff format.

public static void SaveAsTiff(this Image source, Stream stream, TiffEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder TiffEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTiff(Image, string)

Saves the image to the given stream with the Tiff format.

public static void SaveAsTiff(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTiff(Image, string, TiffEncoder)

Saves the image to the given stream with the Tiff format.

public static void SaveAsTiff(this Image source, string path, TiffEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder TiffEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTiffAsync(Image, Stream, TiffEncoder, CancellationToken)

Saves the image to the given stream with the Tiff format.

public static Task SaveAsTiffAsync(this Image source, Stream stream, TiffEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder TiffEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTiffAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Tiff format.

public static Task SaveAsTiffAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsTiffAsync(Image, string)

Saves the image to the given stream with the Tiff format.

public static Task SaveAsTiffAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTiffAsync(Image, string, TiffEncoder, CancellationToken)

Saves the image to the given stream with the Tiff format.

public static Task SaveAsTiffAsync(this Image source, string path, TiffEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder TiffEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsTiffAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Tiff format.

public static Task SaveAsTiffAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsWebp(Image, Stream)

Saves the image to the given stream with the Webp format.

public static void SaveAsWebp(this Image source, Stream stream)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsWebp(Image, Stream, WebpEncoder)

Saves the image to the given stream with the Webp format.

public static void SaveAsWebp(this Image source, Stream stream, WebpEncoder encoder)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder WebpEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsWebp(Image, string)

Saves the image to the given stream with the Webp format.

public static void SaveAsWebp(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsWebp(Image, string, WebpEncoder)

Saves the image to the given stream with the Webp format.

public static void SaveAsWebp(this Image source, string path, WebpEncoder encoder)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder WebpEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsWebpAsync(Image, Stream, WebpEncoder, CancellationToken)

Saves the image to the given stream with the Webp format.

public static Task SaveAsWebpAsync(this Image source, Stream stream, WebpEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
encoder WebpEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsWebpAsync(Image, Stream, CancellationToken)

Saves the image to the given stream with the Webp format.

public static Task SaveAsWebpAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
stream Stream: The stream to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream is null.

SaveAsWebpAsync(Image, string)

Saves the image to the given stream with the Webp format.

public static Task SaveAsWebpAsync(this Image source, string path)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsWebpAsync(Image, string, WebpEncoder, CancellationToken)

Saves the image to the given stream with the Webp format.

public static Task SaveAsWebpAsync(this Image source, string path, WebpEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
encoder WebpEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsWebpAsync(Image, string, CancellationToken)

Saves the image to the given stream with the Webp format.

public static Task SaveAsWebpAsync(this Image source, string path, CancellationToken cancellationToken)

Parameters

source Image: The image this method extends.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the path is null.

SaveAsync(Image, Stream, IImageFormat, CancellationToken)

Writes the image to the given stream using the given image format.

public static Task SaveAsync(this Image source, Stream stream, IImageFormat format, CancellationToken cancellationToken = default)

Parameters

source Image: The source image.
stream Stream: The stream to save the image to.
format IImageFormat: The format to save the image in.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: The stream is null.
ArgumentNullException: The format is null.
NotSupportedException: The stream is not writable.
NotSupportedException: No encoder available for provided format.

SaveAsync(Image, string, IImageEncoder, CancellationToken)

Writes the image to the given file path using the given image encoder.

public static Task SaveAsync(this Image source, string path, IImageEncoder encoder, CancellationToken cancellationToken = default)

Parameters

source Image: The source image.
path string: The file path to save the image to.
encoder IImageEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: The path is null.
ArgumentNullException: The encoder is null.

SaveAsync(Image, string, CancellationToken)

Writes the image to the given file path using an encoder detected from the path.

public static Task SaveAsync(this Image source, string path, CancellationToken cancellationToken = default)

Parameters

source Image: The source image.
path string: The file path to save the image to.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: No encoder available for provided path.

ToBase64String(Image, IImageFormat)

Returns a Base64 encoded string from the given image. The result is prepended with a Data URI https://en.wikipedia.org/wiki/Data_URI_scheme

For example: data:image/gif;base64,R0lGODlhAQABAIABAEdJRgAAACwAAAAAAQABAAACAkQBAA==

public static string ToBase64String(this Image source, IImageFormat format)

Parameters

source Image: The source image
format IImageFormat: The format.

Returns

string: The string

Exceptions

ArgumentNullException: The format is null.

Table of Contents

Class ImageExtensions

Methods

Save(Image, Stream, IImageFormat)

Parameters

Exceptions

Save(Image, string)

Parameters

Exceptions

Save(Image, string, IImageEncoder)

Parameters

Exceptions

SaveAsBmp(Image, Stream)

Parameters

Exceptions

SaveAsBmp(Image, Stream, BmpEncoder)

Parameters

Exceptions

SaveAsBmp(Image, string)

Parameters

Exceptions

SaveAsBmp(Image, string, BmpEncoder)

Parameters

Exceptions

SaveAsBmpAsync(Image, Stream, BmpEncoder, CancellationToken)

Parameters

Returns

Exceptions

SaveAsBmpAsync(Image, Stream, CancellationToken)

Parameters

Returns

Exceptions

SaveAsBmpAsync(Image, string)

Parameters

Returns

Exceptions

SaveAsBmpAsync(Image, string, BmpEncoder, CancellationToken)

Parameters

Returns

Exceptions

SaveAsBmpAsync(Image, string, CancellationToken)

Parameters

Returns

Exceptions

SaveAsGif(Image, Stream)

Parameters

Exceptions

SaveAsGif(Image, Stream, GifEncoder)

Parameters

Exceptions

SaveAsGif(Image, string)

Parameters

Exceptions

SaveAsGif(Image, string, GifEncoder)

Parameters

Exceptions

SaveAsGifAsync(Image, Stream, GifEncoder, CancellationToken)

Parameters

Returns

Exceptions

SaveAsGifAsync(Image, Stream, CancellationToken)

Parameters

Returns

Exceptions

SaveAsGifAsync(Image, string)

Parameters

Returns

Exceptions

SaveAsGifAsync(Image, string, GifEncoder, CancellationToken)

Parameters

Returns

Exceptions

SaveAsGifAsync(Image, string, CancellationToken)

Parameters

Returns

Exceptions

SaveAsJpeg(Image, Stream)

Parameters

Exceptions

SaveAsJpeg(Image, Stream, JpegEncoder)