feat: Dynamic Runtime Rasterized MSDF Sprite Font

sources/Directory.Packages.props

@@ -16,6 +16,7 @@
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.264" />
     <PackageVersion Include="PolySharp" Version="1.15.0" />
+    <PackageVersion Include="Remora.MSDFGen" Version="1.0.0" />
     <PackageVersion Include="ServiceWire" Version="5.6.0" />
     <PackageVersion Include="SharpDX" Version="4.2.0" />
     <PackageVersion Include="SharpDX.D3DCompiler" Version="4.2.0" />
@@ -71,6 +72,7 @@
     <PackageVersion Include="System.Reactive" Version="6.1.0" />
     <PackageVersion Include="System.Reactive.Linq" Version="6.1.0" />
     <PackageVersion Include="System.ServiceProcess.ServiceController" Version="10.0.0" />
+    <PackageVersion Include="MSDF-Sharp.Core" Version="1.0.2"/>
   </ItemGroup>
   <!-- Visual Studio dependencies -->
   <ItemGroup>

sources/core/Stride.Core.Design/Yaml/YamlSerializerBase.cs

@@ -41,8 +41,9 @@ public virtual void ResetCache()
 
     private void AssemblyRegistered(object? sender, AssemblyRegisteredEventArgs e)
     {
-        // Process only our own assemblies
-        if (!e.Categories.Contains(AssemblyCommonCategories.Engine))
+        // Process engine and asset assemblies, since asset YAML tag resolution depends on both.
+        if (!e.Categories.Contains(AssemblyCommonCategories.Engine) &&
+            !e.Categories.Contains(AssemblyCommonCategories.Assets))
             return;
 
         lock (Lock)
@@ -56,8 +57,9 @@ private void AssemblyRegistered(object? sender, AssemblyRegisteredEventArgs e)
 
     private void AssemblyUnregistered(object? sender, AssemblyRegisteredEventArgs e)
     {
-        // Process only our own assemblies
-        if (!e.Categories.Contains(AssemblyCommonCategories.Engine))
+        // Process engine and asset assemblies, since asset YAML tag resolution depends on both.
+        if (!e.Categories.Contains(AssemblyCommonCategories.Engine) &&
+            !e.Categories.Contains(AssemblyCommonCategories.Assets))
             return;
 
         lock (Lock)

sources/editor/Stride.Assets.Presentation/Stride.Assets.Presentation.sdpkg

@@ -19,6 +19,7 @@ TemplateFolders:
         - !file Templates/Assets/BepuPhysics/HullAsset.sdtpl
         - !file Templates/Assets/Fonts/OfflineRasterizedSpriteFont.sdtpl
         - !file Templates/Assets/Fonts/RuntimeRasterizedSpriteFont.sdtpl
+        - !file Templates/Assets/Fonts/RuntimeSignedDistanceFieldSpriteFont.sdtpl
         - !file Templates/Assets/Fonts/SignedDistanceFieldSpriteFont.sdtpl
         - !file Templates/Assets/Materials/DefaultMaterial.sdtpl
         - !file Templates/Assets/Materials/DiffuseMaterial.sdtpl

sources/editor/Stride.Assets.Presentation/Templates/Assets/Fonts/RuntimeSignedDistanceFieldSpriteFont.sdtpl

@@ -0,0 +1,11 @@
+!TemplateAssetFactory
+Id: 8D9A0F2D-2C9A-4F59-B8C1-0F4A6E6B9D11
+AssetTypeName: SpriteFontAsset
+Name: "Runtime SDF"
+Scope: Asset
+Description: A runtime signed-distance-field sprite font asset in which glyphs are generated at runtime from the embedded font file
+Group: Font
+Order: -70
+Icon: ..\.sdtpl\SpriteFont.png
+DefaultOutputName: SpriteFont
+FactoryTypeName: RuntimeSignedDistanceFieldSpriteFontFactory

sources/editor/Stride.Assets.Presentation/Thumbnails/FontThumbnailCompiler.cs

@@ -1,14 +1,15 @@
 // Copyright (c) .NET Foundation and Contributors (https://dotnetfoundation.org/ & https://stride3d.net) and Silicon Studio Corp. (https://www.siliconstudio.co.jp)
 // Distributed under the MIT license. See the LICENSE.md file in the project root for more information.
 using System.IO;
+using Stride.Assets.SpriteFont;
 using Stride.Core.Assets;
 using Stride.Core.Assets.Compiler;
 using Stride.Core.BuildEngine;
 using Stride.Core.IO;
-using Stride.Assets.SpriteFont;
 using Stride.Editor.Resources;
 using Stride.Editor.Thumbnails;
 using Stride.Graphics;
+using Stride.Graphics.Font;
 
 namespace Stride.Assets.Presentation.Thumbnails
 {
@@ -55,12 +56,42 @@ public FontThumbnailBuildCommand(ThumbnailCompilerContext context, string url, A
 
         protected override void SetThumbnailParameters()
         {
-            Font = LoadedAsset;
             FontSize = 0.75f;
             TitleText = BuildTitleText();
 
-            if (Font != null && Font.FontType == SpriteFontType.SDF)
+            bool usingRasterizedPreviewForRuntimeSdf = false;
+
+            if (LoadedAsset is RuntimeSignedDistanceFieldSpriteFont runtimeSdfFont)
+            {
+                var fontSystem = runtimeSdfFont.FontSystem;
+                if (fontSystem != null)
+                {
+                    Font = fontSystem.NewDynamic(
+                        defaultSize: runtimeSdfFont.Size,
+                        fontName: runtimeSdfFont.FontName,
+                        style: runtimeSdfFont.Style,
+                        antiAliasMode: FontAntiAliasMode.Grayscale,
+                        useKerning: runtimeSdfFont.UseKerning,
+                        extraSpacing: 0,
+                        extraLineSpacing: 0,
+                        defaultCharacter: runtimeSdfFont.DefaultCharacter ?? ' ');
+
+                    usingRasterizedPreviewForRuntimeSdf = true;
+                }
+                else
+                {
+                    Font = LoadedAsset;
+                }
+            }
+            else
+            {
+                Font = LoadedAsset;
+            }
+
+            if (!usingRasterizedPreviewForRuntimeSdf && Font != null && Font.FontType == SpriteFontType.SDF)
                 EffectInstance = UIBatch.SDFSpriteFontEffect;
+            else
+                EffectInstance = null;
         }
 
         protected virtual string BuildTitleText()

sources/editor/Stride.Editor/Thumbnails/ThumbnailFromTextureCommand.cs

@@ -1,10 +1,12 @@
 // Copyright (c) .NET Foundation and Contributors (https://dotnetfoundation.org/ & https://stride3d.net) and Silicon Studio Corp. (https://www.siliconstudio.co.jp)
 // Distributed under the MIT license. See the LICENSE.md file in the project root for more information.
 using System;
+using System.IO;
 using Stride.Core.Assets;
 using Stride.Core.Mathematics;
 using Stride.Engine;
 using Stride.Graphics;
+using Stride.Graphics.Font;
 using Stride.Rendering;
 using Stride.Rendering.Compositing;
 
@@ -92,12 +94,23 @@ protected override void RenderSprites(RenderDrawContext context)
                     // Get the exact size of the font rendered with the desired size
                     typeNameSize = Font.MeasureString(TitleText, desiredFontSize);
 
-                    // force pre-generation of the glyph
+                    // Force pre-generation of the glyphs
                     Font.PreGenerateGlyphs(TitleText, new Vector2(desiredFontSize, desiredFontSize));
                 }
 
                 // the title text
-                SpriteBatch.DrawString(Font, TitleText, desiredFontSize, thumbnailSize/2, FontColor, 0, typeNameSize/2, scale*Vector2.One, SpriteEffects.None, 1, TextAlignment.Center);
+                SpriteBatch.DrawString(
+                    Font,
+                    TitleText,
+                    desiredFontSize,
+                    thumbnailSize / 2,
+                    FontColor,
+                    0,
+                    typeNameSize / 2,
+                    scale * Vector2.One,
+                    SpriteEffects.None,
+                    1,
+                    TextAlignment.Center);
             }
         }
     }

sources/engine/Stride.Assets.Tests/SpriteFont/RuntimeSignedDistanceFieldDiagnosticsTests.cs

@@ -0,0 +1,116 @@
+using System;
+using System.IO;
+using System.Linq;
+using System.Reflection;
+using Stride.Assets.SpriteFont;
+using Stride.Core.Assets;
+using Stride.Core.Reflection;
+using Stride.Core.Yaml;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Stride.Assets.Tests.SpriteFont
+{
+    public class RuntimeSignedDistanceFieldSpriteFontDiagnosticsTests
+    {
+        private readonly ITestOutputHelper output;
+
+        public RuntimeSignedDistanceFieldSpriteFontDiagnosticsTests(ITestOutputHelper output)
+        {
+            this.output = output;
+        }
+
+        private static string GetLogPath(string name)
+        {
+            var dir = Path.Combine(AppContext.BaseDirectory, "DiagnosticLogs");
+            Directory.CreateDirectory(dir);
+            return Path.Combine(dir, $"{name}.txt");
+        }
+
+        private void WriteLog(string name, string content)
+        {
+            var path = GetLogPath(name);
+            File.WriteAllText(path, content);
+            output.WriteLine($"Diagnostic log written: {path}");
+        }
+
+        [Fact]
+        public void RuntimeSdfType_Should_Exist_And_Have_Expected_DataContract_Name()
+        {
+            var type = typeof(RuntimeSignedDistanceFieldSpriteFontType);
+
+            Assert.Equal("RuntimeSignedDistanceFieldSpriteFontType", type.Name);
+        }
+
+        [Fact]
+        public void AssemblyRegistry_Should_Contain_RuntimeSdfType_Assembly()
+        {
+            var allAssemblies = AssemblyRegistry.FindAll().ToList();
+            var runtimeAssembly = typeof(RuntimeSignedDistanceFieldSpriteFontType).Assembly;
+
+            Assert.Contains(runtimeAssembly, allAssemblies);
+        }
+
+        [Fact]
+        public void AssetYamlSerializer_Should_Deserialize_RuntimeSdf_SpriteFontAsset()
+        {
+            var yaml = """
+                !SpriteFont
+                Id: cad320b3-3f55-43a4-bb8b-46097724ba24
+                SerializedVersion: {Stride: 2.0.0.0}
+                Tags: []
+                FontSource: !FileFontProvider
+                    Source: !file ../../../../../Downloads/NotoSansCJK-Regular.ttc
+                FontType: !RuntimeSignedDistanceFieldSpriteFontType
+                    Size: 64.0
+                    PixelRange: 10
+                Spacing: 2.0
+                """;
+
+            var serializer = new AssetYamlSerializer();
+            try
+            {
+                using var stream = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(yaml));
+                var result = serializer.Deserialize(stream, typeof(SpriteFontAsset));
+
+                var asset = Assert.IsType<SpriteFontAsset>(result);
+                var fontType = Assert.IsType<RuntimeSignedDistanceFieldSpriteFontType>(asset.FontType);
+
+                Assert.Equal(64.0f, fontType.Size);
+                Assert.Equal(10, fontType.PixelRange);
+                Assert.Equal(2.0f, asset.Spacing);
+            }
+            catch (Exception)
+            {
+                throw;
+            }
+        }
+
+        [Fact]
+        public void AssetYamlSerializer_Settings_Should_Know_RuntimeSdfType_Assembly()
+        {
+            var serializer = new AssetYamlSerializer();
+            var settings = serializer.GetSerializerSettings();
+            var runtimeAssembly = typeof(RuntimeSignedDistanceFieldSpriteFontType).Assembly;
+
+            Assert.NotNull(settings);
+        }
+
+        [Fact]
+        public void SpriteFontAssetCompiler_Dispatch_Precondition_Should_See_RuntimeSdf_FontType()
+        {
+            var asset = new SpriteFontAsset
+            {
+                FontType = new RuntimeSignedDistanceFieldSpriteFontType
+                {
+                    Size = 64,
+                    PixelRange = 10,
+                    Padding = 2
+                },
+                Spacing = 2.0f
+            };
+
+            Assert.True(asset.FontType is RuntimeSignedDistanceFieldSpriteFontType);
+        }
+    }
+}

sources/engine/Stride.Assets.Tests/Stride.Assets.Tests.csproj

@@ -16,6 +16,7 @@
     <Compile Include="..\..\assets\Stride.Core.Assets.Tests\Helpers\GuidGenerator.cs">
       <Link>GuidGenerator.cs</Link>
     </Compile>
+    <Compile Include="SpriteFont\RuntimeSignedDistanceFieldDiagnosticsTests.cs" />
     <Compile Include="TestMemberRequiredComponentChecks.cs" />
     <Compile Include="XunitAttributes.cs" />
     <Compile Include="TestMaterialGenerator.cs" />

sources/engine/Stride.Assets/SpriteFont/RuntimeSignedDistanceFieldSpriteFontType.cs

@@ -0,0 +1,40 @@
+// Copyright (c) .NET Foundation and Contributors (https://dotnetfoundation.org/ & https://stride3d.net)
+// Distributed under the MIT license. See the LICENSE.md file in the project root for more information.
+
+using System.ComponentModel;
+using Stride.Core;
+using Stride.Core.Annotations;
+using Stride.Core.Mathematics;
+
+namespace Stride.Assets.SpriteFont
+{
+    [DataContract("RuntimeSignedDistanceFieldSpriteFontType")]
+    [Display("Runtime SDF")]
+    public class RuntimeSignedDistanceFieldSpriteFontType : SpriteFontTypeBase
+    {
+        /// <inheritdoc/>
+        [DataMember(30)]
+        [DataMemberRange(MathUtil.ZeroTolerance, 2)]
+        [DefaultValue(20)]
+        [Display("Default Size")]
+        public override float Size { get; set; } = 64;
+
+        /// <summary>
+        /// Distance field range/spread (in pixels) used during MSDF generation.
+        /// </summary>
+        [DataMember(40)]
+        [DefaultValue(8)]
+        [DataMemberRange(1, 64, 1, 4, 0)]
+        [Display("Pixel Range")]
+        public int PixelRange { get; set; } = 8;
+
+        /// <summary>
+        /// Extra padding around each glyph inside the atlas (in pixels).
+        /// </summary>
+        [DataMember(50)]
+        [DefaultValue(2)]
+        [DataMemberRange(0, 16, 1, 2, 0)]
+        [Display("Padding")]
+        public int Padding { get; set; } = 2;
+    }
+}