diff --git a/src/ImageSharp/ImageExtensions.cs b/src/ImageSharp/ImageExtensions.cs
index 192287ba5..d8cda2f8f 100644
--- a/src/ImageSharp/ImageExtensions.cs
+++ b/src/ImageSharp/ImageExtensions.cs
@@ -19,10 +19,10 @@ namespace SixLabors.ImageSharp
{
#if !NETSTANDARD1_1
///
- /// Saves the image to the given stream using the currently loaded image format.
+ /// Writes the image to the given stream using the currently loaded image format.
///
- /// The Pixel format.
- /// The source image
+ /// The pixel format.
+ /// The source image.
/// The file path to save the image to.
/// Thrown if the stream is null.
public static void Save(this Image source, string filePath)
@@ -62,13 +62,13 @@ namespace SixLabors.ImageSharp
}
///
- /// Saves the image to the given stream using the currently loaded image format.
+ /// Writes the image to the given stream using the currently loaded image format.
///
- /// The Pixel format.
- /// The source image
+ /// The pixel format.
+ /// The source image.
/// The file path to save the image to.
/// The encoder to save the image with.
- /// Thrown if the encoder is null.
+ /// Thrown if the encoder is null.
public static void Save(this Image source, string filePath, IImageEncoder encoder)
where TPixel : struct, IPixel
{
@@ -81,13 +81,13 @@ namespace SixLabors.ImageSharp
#endif
///
- /// Saves the image to the given stream using the currently loaded image format.
+ /// Writes the image to the given stream using the currently loaded image format.
///
/// The Pixel format.
- /// The source image
+ /// The source image.
/// The stream to save the image to.
- /// The format to save the image to.
- /// Thrown if the stream is null.
+ /// The format to save the image in.
+ /// Thrown if the stream is null.
public static void Save(this Image source, Stream stream, IImageFormat format)
where TPixel : struct, IPixel
{
@@ -111,67 +111,67 @@ namespace SixLabors.ImageSharp
}
///
- /// Saves the raw image pixels to a byte array in row-major order.
+ /// Returns the a copy of the image pixels as a byte array in row-major order.
///
- /// The Pixel format.
+ /// The pixel format.
/// The source image
/// A copy of the pixel data as bytes from this frame.
- /// Thrown if the stream is null.
+ /// Thrown if the stream is null.
public static byte[] SavePixelData(this ImageFrame source)
where TPixel : struct, IPixel
=> MemoryMarshal.AsBytes(source.GetPixelSpan()).ToArray();
///
- /// Saves the raw image pixels to the given byte array in row-major order.
+ /// Writes the raw image pixels to the given byte array in row-major order.
///
- /// The Pixel format.
- /// The source image
+ /// The pixel format.
+ /// The source image.
/// The buffer to save the raw pixel data to.
- /// Thrown if the stream is null.
+ /// Thrown if the stream is null.
public static void SavePixelData(this ImageFrame source, byte[] buffer)
where TPixel : struct, IPixel
=> SavePixelData(source, MemoryMarshal.Cast(buffer.AsSpan()));
///
- /// Saves the raw image pixels to the given TPixel array in row-major order.
+ /// Writes the raw image pixels to the given TPixel array in row-major order.
///
- /// The Pixel format.
+ /// The pixel format.
/// The source image
/// The buffer to save the raw pixel data to.
- /// Thrown if the stream is null.
+ /// Thrown if the stream is null.
public static void SavePixelData(this ImageFrame source, TPixel[] buffer)
where TPixel : struct, IPixel
=> SavePixelData(source, buffer.AsSpan());
///
- /// Saves the raw image pixels to a byte array in row-major order.
+ /// Returns a copy of the raw image pixels as a byte array in row-major order.
///
- /// The Pixel format.
- /// The source image
+ /// The pixel format.
+ /// The source image.
/// A copy of the pixel data from the first frame as bytes.
- /// Thrown if the stream is null.
+ /// Thrown if the stream is null.
public static byte[] SavePixelData(this Image source)
where TPixel : struct, IPixel
=> source.Frames.RootFrame.SavePixelData();
///
- /// Saves the raw image pixels to the given byte array in row-major order.
+ /// Writes the raw image pixels to the given byte array in row-major order.
///
- /// The Pixel format.
- /// The source image
+ /// The pixel format.
+ /// The source image.
/// The buffer to save the raw pixel data to.
- /// Thrown if the stream is null.
+ /// Thrown if the stream is null.
public static void SavePixelData(this Image source, byte[] buffer)
where TPixel : struct, IPixel
=> source.Frames.RootFrame.SavePixelData(buffer);
///
- /// Saves the raw image pixels to the given TPixel array in row-major order.
+ /// Writes the raw image pixels to the given TPixel array in row-major order.
///
- /// The Pixel format.
+ /// The pixel format.
/// The source image
/// The buffer to save the raw pixel data to.
- /// Thrown if the stream is null.
+ /// Thrown if the stream is null.
public static void SavePixelData(this Image source, TPixel[] buffer)
where TPixel : struct, IPixel
=> source.Frames.RootFrame.SavePixelData(buffer);
@@ -180,7 +180,7 @@ namespace SixLabors.ImageSharp
/// Returns a Base64 encoded string from the given image.
///
///
- /// The Pixel format.
+ /// The pixel format.
/// The source image
/// The format.
/// The
@@ -196,22 +196,22 @@ namespace SixLabors.ImageSharp
}
///
- /// Saves the raw image to the given byte buffer.
+ /// Writes the raw image bytes to the given byte span.
///
- /// The Pixel format.
+ /// The pixel format.
/// The source image
- /// The buffer to save the raw pixel data to.
+ /// The span to save the raw pixel data to.
/// Thrown if the stream is null.
public static void SavePixelData(this Image source, Span buffer)
where TPixel : struct, IPixel
=> source.Frames.RootFrame.SavePixelData(MemoryMarshal.Cast(buffer));
///
- /// Saves the raw image to the given byte buffer.
+ /// Writes the raw image pixels to the given TPixel span.
///
- /// The Pixel format.
+ /// The pixel format.
/// The source image
- /// The buffer to save the raw pixel data to.
+ /// The span to save the raw pixel data to.
/// Thrown if the stream is null.
public static void SavePixelData(this ImageFrame source, Span buffer)
where TPixel : struct, IPixel