Add TextOptions.LineSpacing.

Author: JimBobSquarePants

src/ImageSharp.Drawing/ImageSharp.Drawing.csproj

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

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

@@ -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/TextOptions.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

tests/ImageSharp.Drawing.Tests/Drawing/Text/TextOptionsTests.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);