Refactored Mutate/Clone APIs

samples/AvatarWithRoundedCorner/Program.cs

@@ -8,56 +8,68 @@ namespace AvatarWithRoundedCorner
     using SixLabors.Primitives;
     using SixLabors.Shapes;
 
-    class Program
+    static class Program
     {
         static void Main(string[] args)
         {
             System.IO.Directory.CreateDirectory("output");
+            using (var img = Image.Load("fb.jpg"))
+            {
+                // as generate returns a new IImage make sure we dispose of it
+                using (Image<Rgba32> dest = img.Clone(x => x.ConvertToAvatar(new Size(200, 200), 20)))
+                {
+                    dest.Save("output/fb.png");
+                }
 
-            GenerateAvatar("fb.jpg", "output/fb.png", new Size(200, 200), 20);
-            GenerateAvatar("fb.jpg", "output/fb-round.png", new Size(200, 200), 100);
-            GenerateAvatar("fb.jpg", "output/fb-rounder.png", new Size(200, 200), 150);
+                using (Image<Rgba32> destRound = img.Clone(x => x.ConvertToAvatar(new Size(200, 200), 100)))
+                {
+                    destRound.Save("output/fb-round.png");
+                }
+
+                using (Image<Rgba32> destRound = img.Clone(x => x.ConvertToAvatar(new Size(200, 200), 150)))
+                {
+                    destRound.Save("output/fb-rounder.png");
+                }
+
+                // the original `img` object has not been altered at all.
+            }
         }
 
-        private static void GenerateAvatar(string source, string destination, Size size, float cornerRadius)
+        // lets create our custom image mutating pipeline
+        private static IImageOperations<Rgba32> ConvertToAvatar(this IImageOperations<Rgba32> operations, Size size, float cornerRadius)
         {
-            using (var image = Image.Load(source))
+            return operations.Resize(new ImageSharp.Processing.ResizeOptions
             {
-                image.Resize(new ImageSharp.Processing.ResizeOptions
-                {
-                    Size = size,
-                    Mode = ImageSharp.Processing.ResizeMode.Crop
-                });
-
-                ApplyRoundedCourners(image, cornerRadius);
-                image.Save(destination);
-            }
+                Size = size,
+                Mode = ImageSharp.Processing.ResizeMode.Crop
+            }).Run(i => ApplyRoundedCourners(i, cornerRadius));
         }
 
+        // the combination of `IImageOperations.Run()` + this could be replaced with an `IImageProcessor`
         public static void ApplyRoundedCourners(Image<Rgba32> img, float cornerRadius)
         {
             var corners = BuildCorners(img.Width, img.Height, cornerRadius);
-            // now we have our corners time to draw them
-            img.Fill(Rgba32.Transparent, corners, new GraphicsOptions(true)
+
+            // mutating in here as we already have a cloned original
+            img.Mutate(x => x.Fill(Rgba32.Transparent, corners, new GraphicsOptions(true)
             {
                 BlenderMode = ImageSharp.PixelFormats.PixelBlenderMode.Src // enforces that any part of this shape that has color is punched out of the background
-            });
+            }));
         }
 
-        public static  IPathCollection BuildCorners(int imageWidth, int imageHeight, float cornerRadius)
+        public static IPathCollection BuildCorners(int imageWidth, int imageHeight, float cornerRadius)
         {
             // first create a square
             var rect = new SixLabors.Shapes.RectangularePolygon(-0.5f, -0.5f, cornerRadius, cornerRadius);
 
             // then cut out of the square a circle so we are left with a corner
-            var cornerToptLeft = rect.Clip(new SixLabors.Shapes.EllipsePolygon(cornerRadius-0.5f, cornerRadius - 0.5f, cornerRadius));
+            var cornerToptLeft = rect.Clip(new SixLabors.Shapes.EllipsePolygon(cornerRadius - 0.5f, cornerRadius - 0.5f, cornerRadius));
 
             // corner is now a corner shape positions top left
             //lets make 3 more positioned correctly, we cando that by translating the orgional artound the center of the image
             var center = new Vector2(imageWidth / 2, imageHeight / 2);
-            var angle = Math.PI / 2f;
 
-            float rightPos = imageWidth - cornerToptLeft.Bounds.Width  +1;
+            float rightPos = imageWidth - cornerToptLeft.Bounds.Width + 1;
             float bottomPos = imageHeight - cornerToptLeft.Bounds.Height + 1;
 
             // move it across the widthof the image - the width of the shape

src/ImageSharp.Drawing/DrawImage.cs

@@ -24,7 +24,7 @@ public static partial class ImageExtensions
         /// <param name="location">The location to draw the blended image.</param>
         /// <param name="options">The options.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawImage<TPixel>(this Image<TPixel> source, Image<TPixel> image, Size size, Point location, GraphicsOptions options)
+        public static IImageOperations<TPixel> DrawImage<TPixel>(this IImageOperations<TPixel> source, Image<TPixel> image, Size size, Point location, GraphicsOptions options)
             where TPixel : struct, IPixel<TPixel>
         {
             if (size == default(Size))
@@ -37,7 +37,7 @@ public static Image<TPixel> DrawImage<TPixel>(this Image<TPixel> source, Image<T
                 location = Point.Empty;
             }
 
-            source.ApplyProcessor(new DrawImageProcessor<TPixel>(image, size, location, options), source.Bounds);
+            source.ApplyProcessor(new DrawImageProcessor<TPixel>(image, size, location, options));
             return source;
         }
 
@@ -49,7 +49,7 @@ public static Image<TPixel> DrawImage<TPixel>(this Image<TPixel> source, Image<T
         /// <param name="image">The image to blend with the currently processing image.</param>
         /// <param name="percent">The opacity of the image image to blend. Must be between 0 and 1.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Blend<TPixel>(this Image<TPixel> source, Image<TPixel> image, float percent)
+        public static IImageOperations<TPixel> Blend<TPixel>(this IImageOperations<TPixel> source, Image<TPixel> image, float percent)
             where TPixel : struct, IPixel<TPixel>
         {
             GraphicsOptions options = GraphicsOptions.Default;
@@ -66,7 +66,7 @@ public static Image<TPixel> Blend<TPixel>(this Image<TPixel> source, Image<TPixe
         /// <param name="blender">The blending mode.</param>
         /// <param name="percent">The opacity of the image image to blend. Must be between 0 and 1.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Blend<TPixel>(this Image<TPixel> source, Image<TPixel> image, PixelBlenderMode blender, float percent)
+        public static IImageOperations<TPixel> Blend<TPixel>(this IImageOperations<TPixel> source, Image<TPixel> image, PixelBlenderMode blender, float percent)
             where TPixel : struct, IPixel<TPixel>
         {
             GraphicsOptions options = GraphicsOptions.Default;
@@ -83,7 +83,7 @@ public static Image<TPixel> Blend<TPixel>(this Image<TPixel> source, Image<TPixe
         /// <param name="image">The image to blend with the currently processing image.</param>
         /// <param name="options">The options, including the blending type and belnding amount.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Blend<TPixel>(this Image<TPixel> source, Image<TPixel> image, GraphicsOptions options)
+        public static IImageOperations<TPixel> Blend<TPixel>(this IImageOperations<TPixel> source, Image<TPixel> image, GraphicsOptions options)
             where TPixel : struct, IPixel<TPixel>
         {
             return DrawImage(source, image, default(Size), default(Point), options);
@@ -99,7 +99,7 @@ public static Image<TPixel> Blend<TPixel>(this Image<TPixel> source, Image<TPixe
         /// <param name="size">The size to draw the blended image.</param>
         /// <param name="location">The location to draw the blended image.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawImage<TPixel>(this Image<TPixel> source, Image<TPixel> image, float percent, Size size, Point location)
+        public static IImageOperations<TPixel> DrawImage<TPixel>(this IImageOperations<TPixel> source, Image<TPixel> image, float percent, Size size, Point location)
             where TPixel : struct, IPixel<TPixel>
         {
             GraphicsOptions options = GraphicsOptions.Default;
@@ -118,7 +118,7 @@ public static Image<TPixel> DrawImage<TPixel>(this Image<TPixel> source, Image<T
         /// <param name="size">The size to draw the blended image.</param>
         /// <param name="location">The location to draw the blended image.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawImage<TPixel>(this Image<TPixel> source, Image<TPixel> image, PixelBlenderMode blender, float percent, Size size, Point location)
+        public static IImageOperations<TPixel> DrawImage<TPixel>(this IImageOperations<TPixel> source, Image<TPixel> image, PixelBlenderMode blender, float percent, Size size, Point location)
             where TPixel : struct, IPixel<TPixel>
         {
             GraphicsOptions options = GraphicsOptions.Default;

src/ImageSharp.Drawing/FillRegion.cs

@@ -23,7 +23,7 @@ public static partial class ImageExtensions
         /// <param name="brush">The details how to fill the region of interest.</param>
         /// <param name="options">The graphics options.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixel> brush, GraphicsOptions options)
+        public static IImageOperations<TPixel> Fill<TPixel>(this IImageOperations<TPixel> source, IBrush<TPixel> brush, GraphicsOptions options)
             where TPixel : struct, IPixel<TPixel>
         {
             return source.Apply(new FillProcessor<TPixel>(brush, options));
@@ -36,7 +36,7 @@ public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixe
         /// <param name="source">The image this method extends.</param>
         /// <param name="brush">The details how to fill the region of interest.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixel> brush)
+        public static IImageOperations<TPixel> Fill<TPixel>(this IImageOperations<TPixel> source, IBrush<TPixel> brush)
             where TPixel : struct, IPixel<TPixel>
         {
             return source.Fill(brush, GraphicsOptions.Default);
@@ -49,7 +49,7 @@ public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixe
         /// <param name="source">The image this method extends.</param>
         /// <param name="color">The color.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, TPixel color)
+        public static IImageOperations<TPixel> Fill<TPixel>(this IImageOperations<TPixel> source, TPixel color)
             where TPixel : struct, IPixel<TPixel>
         {
             return source.Fill(new SolidBrush<TPixel>(color));
@@ -64,7 +64,7 @@ public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, TPixel color
         /// <param name="region">The region.</param>
         /// <param name="options">The graphics options.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixel> brush, Region region, GraphicsOptions options)
+        public static IImageOperations<TPixel> Fill<TPixel>(this IImageOperations<TPixel> source, IBrush<TPixel> brush, Region region, GraphicsOptions options)
           where TPixel : struct, IPixel<TPixel>
         {
             return source.Apply(new FillRegionProcessor<TPixel>(brush, region, options));
@@ -78,7 +78,7 @@ public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixe
         /// <param name="brush">The brush.</param>
         /// <param name="region">The region.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixel> brush, Region region)
+        public static IImageOperations<TPixel> Fill<TPixel>(this IImageOperations<TPixel> source, IBrush<TPixel> brush, Region region)
           where TPixel : struct, IPixel<TPixel>
         {
             return source.Fill(brush, region, GraphicsOptions.Default);
@@ -93,7 +93,7 @@ public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, IBrush<TPixe
         /// <param name="region">The region.</param>
         /// <param name="options">The options.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, TPixel color, Region region, GraphicsOptions options)
+        public static IImageOperations<TPixel> Fill<TPixel>(this IImageOperations<TPixel> source, TPixel color, Region region, GraphicsOptions options)
           where TPixel : struct, IPixel<TPixel>
         {
             return source.Fill(new SolidBrush<TPixel>(color), region, options);
@@ -107,7 +107,7 @@ public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, TPixel color
         /// <param name="color">The color.</param>
         /// <param name="region">The region.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> Fill<TPixel>(this Image<TPixel> source, TPixel color, Region region)
+        public static IImageOperations<TPixel> Fill<TPixel>(this IImageOperations<TPixel> source, TPixel color, Region region)
           where TPixel : struct, IPixel<TPixel>
         {
             return source.Fill(new SolidBrush<TPixel>(color), region);

src/ImageSharp.Drawing/Paths/DrawBeziers.cs

@@ -28,7 +28,7 @@ public static partial class ImageExtensions
         /// <param name="points">The points.</param>
         /// <param name="options">The options.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, IBrush<TPixel> brush, float thickness, PointF[] points, GraphicsOptions options)
+        public static IImageOperations<TPixel> DrawBeziers<TPixel>(this IImageOperations<TPixel> source, IBrush<TPixel> brush, float thickness, PointF[] points, GraphicsOptions options)
            where TPixel : struct, IPixel<TPixel>
         {
             return source.Draw(new Pen<TPixel>(brush, thickness), new Path(new CubicBezierLineSegment(points)), options);
@@ -43,7 +43,7 @@ public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, IBrus
         /// <param name="thickness">The thickness.</param>
         /// <param name="points">The points.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, IBrush<TPixel> brush, float thickness, PointF[] points)
+        public static IImageOperations<TPixel> DrawBeziers<TPixel>(this IImageOperations<TPixel> source, IBrush<TPixel> brush, float thickness, PointF[] points)
            where TPixel : struct, IPixel<TPixel>
         {
             return source.Draw(new Pen<TPixel>(brush, thickness), new Path(new CubicBezierLineSegment(points)));
@@ -58,7 +58,7 @@ public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, IBrus
         /// <param name="thickness">The thickness.</param>
         /// <param name="points">The points.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, TPixel color, float thickness, PointF[] points)
+        public static IImageOperations<TPixel> DrawBeziers<TPixel>(this IImageOperations<TPixel> source, TPixel color, float thickness, PointF[] points)
            where TPixel : struct, IPixel<TPixel>
         {
             return source.DrawBeziers(new SolidBrush<TPixel>(color), thickness, points);
@@ -74,7 +74,7 @@ public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, TPixe
         /// <param name="points">The points.</param>
         /// <param name="options">The options.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, TPixel color, float thickness, PointF[] points, GraphicsOptions options)
+        public static IImageOperations<TPixel> DrawBeziers<TPixel>(this IImageOperations<TPixel> source, TPixel color, float thickness, PointF[] points, GraphicsOptions options)
            where TPixel : struct, IPixel<TPixel>
         {
             return source.DrawBeziers(new SolidBrush<TPixel>(color), thickness, points, options);
@@ -89,7 +89,7 @@ public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, TPixe
         /// <param name="points">The points.</param>
         /// <param name="options">The options.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, IPen<TPixel> pen, PointF[] points, GraphicsOptions options)
+        public static IImageOperations<TPixel> DrawBeziers<TPixel>(this IImageOperations<TPixel> source, IPen<TPixel> pen, PointF[] points, GraphicsOptions options)
            where TPixel : struct, IPixel<TPixel>
         {
             return source.Draw(pen, new Path(new CubicBezierLineSegment(points)), options);
@@ -103,7 +103,7 @@ public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, IPen<
         /// <param name="pen">The pen.</param>
         /// <param name="points">The points.</param>
         /// <returns>The <see cref="Image{TPixel}"/>.</returns>
-        public static Image<TPixel> DrawBeziers<TPixel>(this Image<TPixel> source, IPen<TPixel> pen, PointF[] points)
+        public static IImageOperations<TPixel> DrawBeziers<TPixel>(this IImageOperations<TPixel> source, IPen<TPixel> pen, PointF[] points)
            where TPixel : struct, IPixel<TPixel>
         {
             return source.Draw(pen, new Path(new CubicBezierLineSegment(points)));