Merge pull request #116 from SixLabors/js/fix-114

Add TextOptions.LineSpacing.

Author: JimBobSquarePants

.github/workflows/build-and-test.yml

@@ -76,7 +76,7 @@ jobs:
                   CI: True
                   XUNIT_PATH: .\tests\ImageSharp.Drawing.Tests # Required for xunit
 
-            - name: Store Output Images after failed tests
+            - name: Export Failed Output
               uses: actions/upload-artifact@v2
               if: failure()
               with:

.gitignore

@@ -169,6 +169,7 @@ ClientBin/
 *.publishsettings
 node_modules/
 bower_components/
+.DS_STORE
 
 # RIA/Silverlight projects
 Generated_Code/

ImageSharp.Drawing.sln

@@ -14,7 +14,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_root", "_root", "{C317F1B1
 		ci-test.ps1 = ci-test.ps1
 		Directory.Build.props = Directory.Build.props
 		Directory.Build.targets = Directory.Build.targets
-		GitVersion.yml = GitVersion.yml
 		LICENSE = LICENSE
 		README.md = README.md
 	EndProjectSection

shared-infrastructure

@@ -20,7 +20,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="SixLabors.Fonts" Version="1.0.0-beta0013"/>
+    <PackageReference Include="SixLabors.Fonts" Version="1.0.0-beta13.5" />
     <PackageReference Include="SixLabors.ImageSharp" Version="1.0.2" />
   </ItemGroup>
 

src/ImageSharp.Drawing/ImageSharp.Drawing.csproj

@@ -2,13 +2,11 @@
 // Licensed under the Apache License, Version 2.0.
 
 using System;
-using System.Buffers;
 using System.Collections.Generic;
 using System.Numerics;
 using SixLabors.Fonts;
 using SixLabors.ImageSharp.Drawing.Processing.Processors.Drawing;
 using SixLabors.ImageSharp.Drawing.Shapes.Rasterization;
-using SixLabors.ImageSharp.Drawing.Utilities;
 using SixLabors.ImageSharp.Memory;
 using SixLabors.ImageSharp.PixelFormats;
 using SixLabors.ImageSharp.Processing.Processors;
@@ -56,6 +54,7 @@ protected override void BeforeImageApply()
                 WrappingWidth = this.Options.TextOptions.WrapTextWidth,
                 HorizontalAlignment = this.Options.TextOptions.HorizontalAlignment,
                 VerticalAlignment = this.Options.TextOptions.VerticalAlignment,
+                LineSpacing = this.Options.TextOptions.LineSpacing,
                 FallbackFontFamilies = this.Options.TextOptions.FallbackFonts,
                 ColorFontSupport = this.definition.Options.TextOptions.RenderColorFonts ? ColorFontSupport.MicrosoftColrFormat : ColorFontSupport.None,
             };

src/ImageSharp.Drawing/Processing/Processors/Text/DrawTextProcessor{TPixel}.cs

@@ -3,8 +3,6 @@
 
 using System.Collections.Generic;
 using SixLabors.Fonts;
-using SixLabors.ImageSharp.Drawing.Shapes;
-using SixLabors.ImageSharp.PixelFormats;
 
 namespace SixLabors.ImageSharp.Drawing.Processing
 {
@@ -16,6 +14,7 @@ public class TextOptions : IDeepCloneable<TextOptions>
         private float tabWidth = 4F;
         private float dpiX = 72F;
         private float dpiY = 72F;
+        private float lineSpacing = 1F;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="TextOptions"/> class.
@@ -29,6 +28,7 @@ private TextOptions(TextOptions source)
             this.ApplyKerning = source.ApplyKerning;
             this.DpiX = source.DpiX;
             this.DpiY = source.DpiY;
+            this.LineSpacing = source.LineSpacing;
             this.HorizontalAlignment = source.HorizontalAlignment;
             this.TabWidth = source.TabWidth;
             this.WrapTextWidth = source.WrapTextWidth;
@@ -49,10 +49,7 @@ private TextOptions(TextOptions source)
         /// </summary>
         public float TabWidth
         {
-            get
-            {
-                return this.tabWidth;
-            }
+            get => this.tabWidth;
 
             set
             {
@@ -73,10 +70,7 @@ public float TabWidth
         /// </summary>
         public float DpiX
         {
-            get
-            {
-                return this.dpiX;
-            }
+            get => this.dpiX;
 
             set
             {
@@ -91,10 +85,7 @@ public float DpiX
         /// </summary>
         public float DpiY
         {
-            get
-            {
-                return this.dpiY;
-            }
+            get => this.dpiY;
 
             set
             {
@@ -103,6 +94,21 @@ public float DpiY
             }
         }
 
+        /// <summary>
+        /// Gets or sets the line spacing. Applied as a multiple of the line height.
+        /// Defaults to 1.
+        /// </summary>
+        public float LineSpacing
+        {
+            get => this.lineSpacing;
+
+            set
+            {
+                Guard.IsTrue(value != 0, nameof(this.LineSpacing), "Value must not be equal to 0.");
+                this.lineSpacing = value;
+            }
+        }
+
         /// <summary>
         /// Gets or sets a value indicating how to align the text relative to the rendering space.
         /// If <see cref="WrapTextWidth"/> is greater than zero it will align relative to the space

src/ImageSharp.Drawing/Processing/TextOptions.cs

@@ -204,6 +204,61 @@ public void FontShapesAreRenderedCorrectly_LargeText<TPixel>(
                 false);
         }
 
+        [Theory]
+        [WithSolidFilledImages(400, 550, "White", PixelTypes.Rgba32, 1, 5, true)]
+        [WithSolidFilledImages(400, 550, "White", PixelTypes.Rgba32, 1.5, 3, true)]
+        [WithSolidFilledImages(400, 550, "White", PixelTypes.Rgba32, 2, 2, true)]
+        [WithSolidFilledImages(400, 100, "White", PixelTypes.Rgba32, 1, 5, false)]
+        [WithSolidFilledImages(400, 100, "White", PixelTypes.Rgba32, 1.5, 3, false)]
+        [WithSolidFilledImages(400, 100, "White", PixelTypes.Rgba32, 2, 2, false)]
+        public void FontShapesAreRenderedCorrectly_WithLineSpacing<TPixel>(
+            TestImageProvider<TPixel> provider,
+            float lineSpacing,
+            int lineCount,
+            bool wrap)
+            where TPixel : unmanaged, IPixel<TPixel>
+        {
+            Font font = CreateFont("OpenSans-Regular.ttf", 16);
+
+            var sb = new StringBuilder();
+            string str = "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas porttitor congue massa. Fusce posuere, magna sed pulvinar ultricies, purus lectus malesuada libero, sit amet commodo magna eros quis urna.";
+
+            for (int i = 0; i < lineCount; i++)
+            {
+                sb.AppendLine(str);
+            }
+
+            var textOptions = new TextOptions
+            {
+                ApplyKerning = true,
+                VerticalAlignment = VerticalAlignment.Top,
+                HorizontalAlignment = HorizontalAlignment.Left,
+                LineSpacing = lineSpacing
+            };
+
+            if (wrap)
+            {
+                textOptions.WrapTextWidth = 300;
+            }
+
+            var textGraphicsOptions = new TextGraphicsOptions
+            {
+                TextOptions = textOptions
+            };
+
+            Color color = Color.Black;
+
+            // NET472 is 0.0002 different.
+            var comparer = ImageComparer.TolerantPercentage(0.0003f);
+
+            provider.VerifyOperation(
+                comparer,
+                img => img.Mutate(c => c.DrawText(textGraphicsOptions, sb.ToString(), font, color, new PointF(10, 1))),
+                $"linespacing_{lineSpacing}_linecount_{lineCount}_wrap_{wrap}",
+                false,
+                false);
+        }
+
         [Theory]
         [WithSolidFilledImages(200, 150, "White", PixelTypes.Rgba32, 50, 0, 0, "SixLaborsSampleAB.woff", AB)]
         [WithSolidFilledImages(900, 150, "White", PixelTypes.Rgba32, 50, 0, 0, "OpenSans-Regular.ttf", TestText)]

tests/ImageSharp.Drawing.Tests/Drawing/Text/DrawTextOnImageTests.cs

@@ -71,6 +71,14 @@ public void DefaultTextOptionsWrapTextWidth()
             Assert.Equal(Expected, this.cloneTextOptions.WrapTextWidth);
         }
 
+        [Fact]
+        public void DefaultTextOptionsLineSpacing()
+        {
+            const float Expected = 1F;
+            Assert.Equal(Expected, this.newTextOptions.LineSpacing);
+            Assert.Equal(Expected, this.cloneTextOptions.LineSpacing);
+        }
+
         [Fact]
         public void NonDefaultClone()
         {
@@ -81,6 +89,7 @@ public void NonDefaultClone()
                 DpiY = 52F,
                 HorizontalAlignment = HorizontalAlignment.Center,
                 TabWidth = 3F,
+                LineSpacing = -1F,
                 VerticalAlignment = VerticalAlignment.Bottom,
                 WrapTextWidth = 42F
             };
@@ -90,6 +99,7 @@ public void NonDefaultClone()
             Assert.Equal(expected.ApplyKerning, actual.ApplyKerning);
             Assert.Equal(expected.DpiX, actual.DpiX);
             Assert.Equal(expected.DpiY, actual.DpiY);
+            Assert.Equal(expected.LineSpacing, actual.LineSpacing);
             Assert.Equal(expected.HorizontalAlignment, actual.HorizontalAlignment);
             Assert.Equal(expected.TabWidth, actual.TabWidth);
             Assert.Equal(expected.VerticalAlignment, actual.VerticalAlignment);
@@ -107,12 +117,14 @@ public void CloneIsDeep()
             actual.DpiY = 52F;
             actual.HorizontalAlignment = HorizontalAlignment.Center;
             actual.TabWidth = 3F;
+            actual.LineSpacing = 2F;
             actual.VerticalAlignment = VerticalAlignment.Bottom;
             actual.WrapTextWidth = 42F;
 
             Assert.NotEqual(expected.ApplyKerning, actual.ApplyKerning);
             Assert.NotEqual(expected.DpiX, actual.DpiX);
             Assert.NotEqual(expected.DpiY, actual.DpiY);
+            Assert.NotEqual(expected.LineSpacing, actual.LineSpacing);
             Assert.NotEqual(expected.HorizontalAlignment, actual.HorizontalAlignment);
             Assert.NotEqual(expected.TabWidth, actual.TabWidth);
             Assert.NotEqual(expected.VerticalAlignment, actual.VerticalAlignment);

tests/ImageSharp.Drawing.Tests/Drawing/Text/TextOptionsTests.cs

@@ -1,10 +1,10 @@
-// Copyright (c) Six Labors.
+// Copyright (c) Six Labors.
 // Licensed under the Apache License, Version 2.0.
 
+using System;
+
 namespace SixLabors.ImageSharp.Drawing.Tests
 {
-    using System;
-
     /// <summary>
     /// The output produced by this test class should be grouped into the specified subfolder.
     /// </summary>
@@ -17,4 +17,4 @@ public GroupOutputAttribute(string subfolder)
 
         public string Subfolder { get; }
     }
-}
+}