Added gravity overload to the Splice method (#1881).

Author: dlemstra

src/Magick.NET.Core/IMagickImageCreateOperations.cs

@@ -1154,6 +1154,14 @@ public interface IMagickImageCreateOperations
     /// <exception cref="MagickException">Thrown when an error is raised by ImageMagick.</exception>
     void Splice(IMagickGeometry geometry);
 
+    /// <summary>
+    /// Splice the background color into the image.
+    /// </summary>
+    /// <param name="geometry">The geometry to use.</param>
+    /// <param name="gravity">The gravity to use.</param>
+    /// <exception cref="MagickException">Thrown when an error is raised by ImageMagick.</exception>
+    void Splice(IMagickGeometry geometry, Gravity gravity);
+
     /// <summary>
     /// Spread pixels randomly within image.
     /// </summary>

src/Magick.NET/MagickImage.CloneMutator.cs

@@ -653,7 +653,10 @@ public void SparseColor(Channels channels, SparseColorMethod method, params ISpa
             => SparseColor(channels, method, (IEnumerable<ISparseColorArg<QuantumType>>)args);
 
         public void Splice(IMagickGeometry geometry)
-            => SetResult(NativeMagickImage.Splice(MagickRectangle.FromGeometry(geometry, (uint)NativeMagickImage.Width_Get(), (uint)NativeMagickImage.Height_Get())));
+            => Splice(geometry, Gravity.Undefined);
+
+        public void Splice(IMagickGeometry geometry, Gravity gravity)
+            => SetResult(NativeMagickImage.Splice(MagickRectangle.FromGeometry(geometry, (uint)NativeMagickImage.Width_Get(), (uint)NativeMagickImage.Height_Get()), gravity));
 
         public void Spread()
             => Spread(NativeMagickImage.Interpolate_Get(), 3);

src/Magick.NET/MagickImage.cs

@@ -6358,6 +6358,18 @@ public void Splice(IMagickGeometry geometry)
         mutator.Splice(geometry);
     }
 
+    /// <summary>
+    /// Splice the background color into the image.
+    /// </summary>
+    /// <param name="geometry">The geometry to use.</param>
+    /// <param name="gravity">The gravity to use.</param>
+    /// <exception cref="MagickException">Thrown when an error is raised by ImageMagick.</exception>
+    public void Splice(IMagickGeometry geometry, Gravity gravity)
+    {
+        using var mutator = new Mutator(_nativeInstance);
+        mutator.Splice(geometry, gravity);
+    }
+
     /// <summary>
     /// Spread pixels randomly within image.
     /// </summary>

src/Magick.NET/Native/MagickImage.cs

@@ -718,7 +718,7 @@ private unsafe sealed partial class NativeMagickImage : NativeInstance, INativeM
         public partial IntPtr SparseColor(Channels channel, SparseColorMethod method, double[] values, nuint length);
 
         [Throws]
-        public partial IntPtr Splice(MagickRectangle geometry);
+        public partial IntPtr Splice(MagickRectangle geometry, Gravity gravity);
 
         [Throws]
         public partial IntPtr Spread(PixelInterpolateMethod method, double radius);

tests/Magick.NET.Tests/MagickImageTests/TheSpliceMethod.cs

@@ -19,6 +19,14 @@ public void ShouldThrowExceptionWhenGeometryIsNull()
             Assert.Throws<ArgumentNullException>("geometry", () => image.Splice(null!));
         }
 
+        [Fact]
+        public void ShouldThrowExceptionWhenGeometryIsNullAndGravityIsSpecified()
+        {
+            using var image = new MagickImage();
+
+            Assert.Throws<ArgumentNullException>("geometry", () => image.Splice(null!, Gravity.Center));
+        }
+
         [Fact]
         public void ShouldSpliceTheBackgroundColorIntoTheImage()
         {
@@ -31,5 +39,19 @@ public void ShouldSpliceTheBackgroundColorIntoTheImage()
             ColorAssert.Equal(MagickColors.Fuchsia, image, 105, 50);
             ColorAssert.Equal(new MagickColor("#0000"), image, 115, 70);
         }
+
+        [Fact]
+        public void ShouldUseTheGravityWhenSplicingTheBackgroundColorIntoTheImage()
+        {
+            using var image = new MagickImage(Files.SnakewarePNG);
+            image.BackgroundColor = MagickColors.Fuchsia;
+            image.Splice(new MagickGeometry(105, 50, 10, 20), Gravity.Center);
+
+            Assert.Equal(296U, image.Width);
+            Assert.Equal(87U, image.Height);
+            image.Write("i:/test.png");
+            ColorAssert.Equal(MagickColors.Fuchsia, image, 110, 60);
+            ColorAssert.Equal(new MagickColor("#0000"), image, 109, 59);
+        }
     }
 }