Getting Started

Warning

Fonts is still considered BETA quality and we still reserve the rights to change the API shapes.

Note

The official guide assumes intermediate level knowledge of C# and .NET. If you are totally new to .NET development, it might not be the best idea to jump right into a framework as your first step - grasp the basics then come back. Prior experience with other languages and frameworks helps, but is not required.

Fonts

Fonts provides the core to your text layout and loading subsystems.

• SixLabors.Fonts.FontCollection is the root type you will configure and load up with all the TrueType/OpenType/Woff fonts. (font loading is deemed expensive and should be done once and shared across multiple rasterizations)
• SixLabors.Fonts.Font is our currying type for passing information about your chosen font face.

Loading Fonts

Fonts provides several options for loading fonts, you can load then from a streams or files, we also support loading collections out of *.TTC files and well as single variants out if individual *.TTF files. We also support loading *.woff files.

Minimal Example

using SixLabors.Fonts;

FontCollection collection = new FontCollection();
FontFamily family = collection.Install("path/to/font.ttf");
Font font = family.Create(12, FontStyle.Italic);

// "font" can now be used in calls to DrawText from our ImageSharp.Drawing library.

Expanded Example

using SixLabors.Fonts;

FontCollection collection = new FontCollection();
collection.Install("path/to/font.ttf");
collection.Install("path/to/font2.ttf");
collection.Install("path/to/emojiFont.ttf");
collection.InstallCollection("path/to/font.ttc");

if(collection.TryFind("Font Name", out FontFamily family))
if(collection.TryFind("Emoji Font Name", out FontFamily emojiFamily))
{
    // family will not be null here
    Font font = family.Create(12, FontStyle.Italic);
    RendererOptions options = new RendererOptions(font, dpi: 72)
    {
        ApplyKerning  = true, 
        FallbackFontFamilies  = new []
        {
            emojiFamily // will be used if a particular code point doesn't exist in the font passed into the constructor. (e.g. emoji)
        }
    };
    FontRectangle rect = TextMeasurer.Measure("Text to measure", options);
}