Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roy-t/truetype
A TrueType parser for reading, glyphIds, names, descriptions, and kerning information from TrueType fonts
https://github.com/roy-t/truetype
font opentype parser truetype ttf
Last synced: 3 months ago
JSON representation
A TrueType parser for reading, glyphIds, names, descriptions, and kerning information from TrueType fonts
- Host: GitHub
- URL: https://github.com/roy-t/truetype
- Owner: roy-t
- License: mit
- Created: 2018-06-20T09:01:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-07T19:42:23.000Z (over 1 year ago)
- Last Synced: 2024-10-13T16:44:38.081Z (4 months ago)
- Topics: font, opentype, parser, truetype, ttf
- Language: C#
- Size: 89.8 KB
- Stars: 37
- Watchers: 3
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Roy-T.TrueType
*Current version: 0.2.0*
A TrueType parser for reading, glyphIds, names, descriptions, and kerning information from TrueType fonts. Supports `.NetStandard 2.0`, `.Net 4.6.1` and higher.
You can directly add this library to your project using [NuGet](https://www.nuget.org/packages/RoyT.TrueType/):
```
Install-Package RoyT.TrueType
```
For more information please visit my blog at http://roy-t.nl.
To learn more about the TrueType font format and terminology used here see the [Open Type specification](https://docs.microsoft.com/en-us/typography/opentype/spec/).
## Why choose this library?
- It can read the following tables of all fonts that exist in a standard Windows 10 installation:
- [CMAP](https://learn.microsoft.com/en-us/typography/opentype/spec/cmap), character to glyph index mapping table
- [KERN](https://learn.microsoft.com/en-us/typography/opentype/spec/kern), inter character spacing (kerning)
- [NAME](https://learn.microsoft.com/en-us/typography/opentype/spec/name), multilingual strings for font names, styles, ...
- [MAXP](https://learn.microsoft.com/en-us/typography/opentype/spec/maxp), memory requirements
- [HMTX](https://learn.microsoft.com/en-us/typography/opentype/spec/hmtx), horizontal metrics table
- [VMTX](https://learn.microsoft.com/en-us/typography/opentype/spec/vmtx), vertical metrics table
- [HHEA](https://learn.microsoft.com/en-us/typography/opentype/spec/hhea), horizontal header table
- [VHEA](https://learn.microsoft.com/en-us/typography/opentype/spec/vhea), vertical header table
- [OS2](https://learn.microsoft.com/en-us/typography/opentype/spec/os2) OS/2 and Windows Metric Table
- It exposes both an easy to use API to directly get useful information from these tables, but also exposes the tables themselves so you add your own interpretation of the data
- It works on both `.Net Core 1.0` and `.Net 4.6.1` and higher by targetting `.Net standard 1.6`
## Limitations
- This library aims to read meta-information from .ttf files, it does not give you enough information to render glyphs yourself. For that you need OpenType and HarfBuzz.
## Supported Cmap formats
[Reference](https://docs.microsoft.com/en-us/typography/opentype/spec/cmap)
| Subtable format | supported/unsupported | remarks |
|--- | --- | --- |
| Segmented mapping to delta values | supported | Most common |
| Trimmed table mapping | supported | |
| Segmented coverage | supported | |
| Byte encoding table | supported | Least common |
| High-byte mapping through table | unsupported | I have not seeen a font that uses this yet, samples welcome |
| Mixed 16-bit and 32-bit coverage | unsupported | I have not seeen a font that uses this yet, samples welcome |
| Trimmed array | unsupported | I have not seeen a font that uses this yet, samples welcome |
| Many-to-one range mappings | unsupported | I have not seeen a font that uses this yet, samples welcome |
| Unicode Variation Sequences | unsupported | Specifies variations of a single glyph |
## Usage example
```csharp
var font = TrueTypeFont.FromFile(@"C:\Windows\Fonts\arial.ttf");
// Using the helper functions
var glyphIndex = GlyphHelper.GetGlyphIndex('A', font); // 36
var horizontalKerning = KerningHelper.GetHorizontalKerning('A', 'W', font); // -76
var name = NameHelper.GetName(NameId.FontSubfamilyName, new CultureInfo("nl-NL"), font); // Standaard
// Diving in deep yourself to get some specific information is also possible
if (font.KernTable.SubtableCount > 0)
{
var leftCode = GlyphHelper.GetGlyphIndex(left, font);
var rightCode = GlyphHelper.GetGlyphIndex(right, font);
foreach (var subTable in font.KernTable.Subtables)
{
if (subTable.Format0 != null && subTable.Direction == Direction.Vertical
&& subTable.Values == Values.Kerning)
{
var pair = new KerningPair((ushort)leftCode, (ushort)rightCode);
if (subTable.Format0.Map.TryGetValue(pair, out var value))
{
// Do something
}
}
}
}
```