Normalize parameter order.

SixLabors · Nov 19, 2024 · 3bd1efb · 3bd1efb
1 parent 430ceee
commit 3bd1efb
Show file tree

Hide file tree

Showing 14 changed files with 113 additions and 132 deletions.
diff --git a/src/ImageSharp/Processing/Extensions/Convolution/BokehBlurExtensions.cs b/src/ImageSharp/Processing/Extensions/Convolution/BokehBlurExtensions.cs
@@ -44,13 +44,13 @@ public static IImageProcessingContext BokehBlur(this IImageProcessingContext sou
     /// Applies a bokeh blur to the image.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="radius">The 'radius' value representing the size of the area to sample.</param>
-    /// <param name="components">The 'components' value representing the number of kernels to use to approximate the bokeh effect.</param>
-    /// <param name="gamma">The gamma highlight factor to use to emphasize bright spots in the source image</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="radius">The 'radius' value representing the size of the area to sample.</param>
+    /// <param name="components">The 'components' value representing the number of kernels to use to approximate the bokeh effect.</param>
+    /// <param name="gamma">The gamma highlight factor to use to emphasize bright spots in the source image</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext BokehBlur(this IImageProcessingContext source, int radius, int components, float gamma, Rectangle rectangle)
+    public static IImageProcessingContext BokehBlur(this IImageProcessingContext source, Rectangle rectangle, int radius, int components, float gamma)
         => source.ApplyProcessor(new BokehBlurProcessor(radius, components, gamma), rectangle);
 }
diff --git a/src/ImageSharp/Processing/Extensions/Convolution/BoxBlurExtensions.cs b/src/ImageSharp/Processing/Extensions/Convolution/BoxBlurExtensions.cs
@@ -44,10 +44,10 @@ public static IImageProcessingContext BoxBlur(this IImageProcessingContext sourc
     /// Applies a box blur to the image.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="radius">The 'radius' value representing the size of the area to sample.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="radius">The 'radius' value representing the size of the area to sample.</param>
     /// <param name="borderWrapModeX">
     /// The <see cref="BorderWrappingMode"/> to use when mapping the pixels outside of the border, in X direction.
     /// </param>
@@ -57,8 +57,8 @@ public static IImageProcessingContext BoxBlur(this IImageProcessingContext sourc
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BoxBlur(
         this IImageProcessingContext source,
-        int radius,
         Rectangle rectangle,
+        int radius,
         BorderWrappingMode borderWrapModeX,
         BorderWrappingMode borderWrapModeY)
         => source.ApplyProcessor(new BoxBlurProcessor(radius, borderWrapModeX, borderWrapModeY), rectangle);

diff --git a/src/ImageSharp/Processing/Extensions/Convolution/DetectEdgesExtensions.cs b/src/ImageSharp/Processing/Extensions/Convolution/DetectEdgesExtensions.cs
@@ -16,8 +16,8 @@ public static class DetectEdgesExtensions
     /// </summary>
     /// <param name="source">The current image processing context.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext DetectEdges(this IImageProcessingContext source) =>
-        DetectEdges(source, KnownEdgeDetectorKernels.Sobel);
+    public static IImageProcessingContext DetectEdges(this IImageProcessingContext source)
+        => DetectEdges(source, KnownEdgeDetectorKernels.Sobel);
 
     /// <summary>
     /// Detects any edges within the image.
@@ -28,21 +28,17 @@ public static IImageProcessingContext DetectEdges(this IImageProcessingContext s
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext DetectEdges(
-        this IImageProcessingContext source,
-        Rectangle rectangle) =>
-        DetectEdges(source, KnownEdgeDetectorKernels.Sobel, rectangle);
+    public static IImageProcessingContext DetectEdges(this IImageProcessingContext source, Rectangle rectangle)
+        => DetectEdges(source, rectangle, KnownEdgeDetectorKernels.Sobel);
 
     /// <summary>
     /// Detects any edges within the image operating in grayscale mode.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
     /// <param name="kernel">The 2D edge detector kernel.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext DetectEdges(
-        this IImageProcessingContext source,
-        EdgeDetector2DKernel kernel) =>
-        DetectEdges(source, kernel, true);
+    public static IImageProcessingContext DetectEdges(this IImageProcessingContext source, EdgeDetector2DKernel kernel)
+        => DetectEdges(source, kernel, true);
 
     /// <summary>
     /// Detects any edges within the image using a <see cref="EdgeDetector2DKernel"/>.
@@ -57,60 +53,50 @@ public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
         EdgeDetector2DKernel kernel,
         bool grayscale)
-    {
-        var processor = new EdgeDetector2DProcessor(kernel, grayscale);
-        source.ApplyProcessor(processor);
-        return source;
-    }
+        => source.ApplyProcessor(new EdgeDetector2DProcessor(kernel, grayscale));
 
     /// <summary>
     /// Detects any edges within the image operating in grayscale mode.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="kernel">The 2D edge detector kernel.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="kernel">The 2D edge detector kernel.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
-        EdgeDetector2DKernel kernel,
-        Rectangle rectangle) =>
-        DetectEdges(source, kernel, true, rectangle);
+        Rectangle rectangle,
+        EdgeDetector2DKernel kernel)
+        => DetectEdges(source, rectangle, kernel, true);
 
     /// <summary>
     /// Detects any edges within the image using a <see cref="EdgeDetector2DKernel"/>.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
+    /// <param name="rectangle">
+    /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
+    /// </param>
     /// <param name="kernel">The 2D edge detector kernel.</param>
     /// <param name="grayscale">
     /// Whether to convert the image to grayscale before performing edge detection.
     /// </param>
-    /// <param name="rectangle">
-    /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
-    /// </param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
+        Rectangle rectangle,
         EdgeDetector2DKernel kernel,
-        bool grayscale,
-        Rectangle rectangle)
-    {
-        var processor = new EdgeDetector2DProcessor(kernel, grayscale);
-        source.ApplyProcessor(processor, rectangle);
-        return source;
-    }
+        bool grayscale)
+        => source.ApplyProcessor(new EdgeDetector2DProcessor(kernel, grayscale), rectangle);
 
     /// <summary>
     /// Detects any edges within the image operating in grayscale mode.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
     /// <param name="kernel">The edge detector kernel.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext DetectEdges(
-        this IImageProcessingContext source,
-        EdgeDetectorKernel kernel) =>
-        DetectEdges(source, kernel, true);
+    public static IImageProcessingContext DetectEdges(this IImageProcessingContext source, EdgeDetectorKernel kernel)
+        => DetectEdges(source, kernel, true);
 
     /// <summary>
     /// Detects any edges within the image using a <see cref="EdgeDetectorKernel"/>.
@@ -125,66 +111,56 @@ public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
         EdgeDetectorKernel kernel,
         bool grayscale)
-    {
-        var processor = new EdgeDetectorProcessor(kernel, grayscale);
-        source.ApplyProcessor(processor);
-        return source;
-    }
+        => source.ApplyProcessor(new EdgeDetectorProcessor(kernel, grayscale));
 
     /// <summary>
     /// Detects any edges within the image operating in grayscale mode.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="kernel">The edge detector kernel.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="kernel">The edge detector kernel.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
-        EdgeDetectorKernel kernel,
-        Rectangle rectangle) =>
-        DetectEdges(source, kernel, true, rectangle);
+        Rectangle rectangle,
+        EdgeDetectorKernel kernel)
+        => DetectEdges(source, rectangle, kernel, true);
 
     /// <summary>
     /// Detects any edges within the image using a <see cref="EdgeDetectorKernel"/>.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
+    /// <param name="rectangle">
+    /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
+    /// </param>
     /// <param name="kernel">The edge detector kernel.</param>
     /// <param name="grayscale">
     /// Whether to convert the image to grayscale before performing edge detection.
     /// </param>
-    /// <param name="rectangle">
-    /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
-    /// </param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
+        Rectangle rectangle,
         EdgeDetectorKernel kernel,
-        bool grayscale,
-        Rectangle rectangle)
-    {
-        var processor = new EdgeDetectorProcessor(kernel, grayscale);
-        source.ApplyProcessor(processor, rectangle);
-        return source;
-    }
+        bool grayscale)
+        => source.ApplyProcessor(new EdgeDetectorProcessor(kernel, grayscale), rectangle);
 
     /// <summary>
     /// Detects any edges within the image operating in grayscale mode.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="kernel">Thecompass edge detector kernel.</param>
+    /// <param name="kernel">The compass edge detector kernel.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext DetectEdges(
-        this IImageProcessingContext source,
-        EdgeDetectorCompassKernel kernel) =>
-        DetectEdges(source, kernel, true);
+    public static IImageProcessingContext DetectEdges(this IImageProcessingContext source, EdgeDetectorCompassKernel kernel)
+        => DetectEdges(source, kernel, true);
 
     /// <summary>
     /// Detects any edges within the image using a <see cref="EdgeDetectorCompassKernel"/>.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="kernel">Thecompass edge detector kernel.</param>
+    /// <param name="kernel">The compass edge detector kernel.</param>
     /// <param name="grayscale">
     /// Whether to convert the image to grayscale before performing edge detection.
     /// </param>
@@ -193,47 +169,39 @@ public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
         EdgeDetectorCompassKernel kernel,
         bool grayscale)
-    {
-        var processor = new EdgeDetectorCompassProcessor(kernel, grayscale);
-        source.ApplyProcessor(processor);
-        return source;
-    }
+        => source.ApplyProcessor(new EdgeDetectorCompassProcessor(kernel, grayscale));
 
     /// <summary>
     /// Detects any edges within the image operating in grayscale mode.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="kernel">Thecompass edge detector kernel.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="kernel">The compass edge detector kernel.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
-        EdgeDetectorCompassKernel kernel,
-        Rectangle rectangle) =>
-        DetectEdges(source, kernel, true, rectangle);
+        Rectangle rectangle,
+        EdgeDetectorCompassKernel kernel)
+        => DetectEdges(source, rectangle, kernel, true);
 
     /// <summary>
     /// Detects any edges within the image using a <see cref="EdgeDetectorCompassKernel"/>.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="kernel">Thecompass edge detector kernel.</param>
-    /// <param name="grayscale">
-    /// Whether to convert the image to grayscale before performing edge detection.
-    /// </param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="kernel">The compass edge detector kernel.</param>
+    /// <param name="grayscale">
+    /// Whether to convert the image to grayscale before performing edge detection.
+    /// </param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext DetectEdges(
         this IImageProcessingContext source,
+        Rectangle rectangle,
         EdgeDetectorCompassKernel kernel,
-        bool grayscale,
-        Rectangle rectangle)
-    {
-        var processor = new EdgeDetectorCompassProcessor(kernel, grayscale);
-        source.ApplyProcessor(processor, rectangle);
-        return source;
-    }
+        bool grayscale)
+        => source.ApplyProcessor(new EdgeDetectorCompassProcessor(kernel, grayscale), rectangle);
 }
diff --git a/src/ImageSharp/Processing/Extensions/Convolution/GaussianBlurExtensions.cs b/src/ImageSharp/Processing/Extensions/Convolution/GaussianBlurExtensions.cs
@@ -32,32 +32,37 @@ public static IImageProcessingContext GaussianBlur(this IImageProcessingContext
     /// Applies a Gaussian blur to the image.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="sigma">The 'sigma' value representing the weight of the blur.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="sigma">The 'sigma' value representing the weight of the blur.</param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext GaussianBlur(this IImageProcessingContext source, float sigma, Rectangle rectangle)
+    public static IImageProcessingContext GaussianBlur(
+        this IImageProcessingContext source,
+        Rectangle rectangle,
+        float sigma)
         => source.ApplyProcessor(new GaussianBlurProcessor(sigma), rectangle);
 
     /// <summary>
     /// Applies a Gaussian blur to the image.
     /// </summary>
     /// <param name="source">The current image processing context.</param>
-    /// <param name="sigma">The 'sigma' value representing the weight of the blur.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
+    /// <param name="sigma">The 'sigma' value representing the weight of the blur.</param>
     /// <param name="borderWrapModeX">
     /// The <see cref="BorderWrappingMode"/> to use when mapping the pixels outside of the border, in X direction.
     /// </param>
     /// <param name="borderWrapModeY">
     /// The <see cref="BorderWrappingMode"/> to use when mapping the pixels outside of the border, in Y direction.
     /// </param>
     /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
-    public static IImageProcessingContext GaussianBlur(this IImageProcessingContext source, float sigma, Rectangle rectangle, BorderWrappingMode borderWrapModeX, BorderWrappingMode borderWrapModeY)
-    {
-        GaussianBlurProcessor processor = new(sigma, borderWrapModeX, borderWrapModeY);
-        return source.ApplyProcessor(processor, rectangle);
-    }
+    public static IImageProcessingContext GaussianBlur(
+        this IImageProcessingContext source,
+        Rectangle rectangle,
+        float sigma,
+        BorderWrappingMode borderWrapModeX,
+        BorderWrappingMode borderWrapModeY)
+        => source.ApplyProcessor(new GaussianBlurProcessor(sigma, borderWrapModeX, borderWrapModeY), rectangle);
 }