Class UIFontFace

Namespace

Forma

Assembly

Forma.DynamicText.dll

public sealed class UIFontFace : IDisposable

Inheritance

object

UIFontFace

Implements

IDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

MaximumFaces

public const int MaximumFaces = 256

Field Value

int

MaximumGlyphArea

public const int MaximumGlyphArea = 16777216

Field Value

int

MaximumGlyphDimension

public const int MaximumGlyphDimension = 4096

Field Value

int

MaximumSourceBytes

public const int MaximumSourceBytes = 67108864

Field Value

int

MaximumTableBytes

public const int MaximumTableBytes = 33554432

Field Value

int

MaximumTables

public const int MaximumTables = 4096

Field Value

int

Properties

DesignMetrics

public UIFontFaceMetrics DesignMetrics { get; }

Property Value

UIFontFaceMetrics

FaceCount

public int FaceCount { get; }

Property Value

int

FaceIndex

public int FaceIndex { get; }

Property Value

int

FamilyName

public string FamilyName { get; }

Property Value

string

GlyphCount

public int GlyphCount { get; }

Property Value

int

Identity

public UIFontIdentity Identity { get; }

Property Value

UIFontIdentity

StyleName

public string StyleName { get; }

Property Value

string

UnitsPerEm

public ushort UnitsPerEm { get; }

Property Value

ushort

VariationAxes

public IReadOnlyList<UIFontVariationAxis> VariationAxes { get; }

Property Value

IReadOnlyList<UIFontVariationAxis>

Methods

Dispose()

public void Dispose()

FromMemory(ReadOnlyMemory<byte>, int)

public static UIFontFace FromMemory(ReadOnlyMemory<byte> source, int faceIndex = 0)

Parameters

source ReadOnlyMemory<byte>

faceIndex int

Returns

UIFontFace

FromProjectFile(string, string, int)

public static UIFontFace FromProjectFile(string projectDirectory, string relativePath, int faceIndex = 0)

Parameters

projectDirectory string

relativePath string

faceIndex int

Returns

UIFontFace

FromStream(Stream, int)

public static UIFontFace FromStream(Stream source, int faceIndex = 0)

Parameters

source Stream

faceIndex int

Returns

UIFontFace

GetGlyphId(int)

public uint GetGlyphId(int unicodeScalar)

Parameters

unicodeScalar int

Returns

uint

GetGlyphMetrics(uint, float, IReadOnlyList<UIFontVariationCoordinate>)

public UIFontGlyphMetrics GetGlyphMetrics(uint glyphId, float logicalSize, IReadOnlyList<UIFontVariationCoordinate> variations = null)

Parameters

glyphId uint

logicalSize float

variations IReadOnlyList<UIFontVariationCoordinate>

Returns

UIFontGlyphMetrics

GetMetrics(float)

public UIFontFaceMetrics GetMetrics(float logicalSize)

Parameters

logicalSize float

Returns

UIFontFaceMetrics

GetSupportedCodePoints()

public IReadOnlyList<int> GetSupportedCodePoints()

Returns

IReadOnlyList<int>

RasterizeCharacter(int, float, float, UIFontHinting, IReadOnlyList<UIFontVariationCoordinate>)

public UIFontGlyphBitmap RasterizeCharacter(int unicodeScalar, float logicalSize, float displayScale = 1, UIFontHinting hinting = UIFontHinting.Default, IReadOnlyList<UIFontVariationCoordinate> variations = null)

Parameters

unicodeScalar int

logicalSize float

displayScale float

hinting UIFontHinting

variations IReadOnlyList<UIFontVariationCoordinate>

Returns

UIFontGlyphBitmap

RasterizeGlyph(uint, float, float, UIFontHinting, IReadOnlyList<UIFontVariationCoordinate>)

public UIFontGlyphBitmap RasterizeGlyph(uint glyphId, float logicalSize, float displayScale = 1, UIFontHinting hinting = UIFontHinting.Default, IReadOnlyList<UIFontVariationCoordinate> variations = null)

Parameters

glyphId uint

logicalSize float

displayScale float

hinting UIFontHinting

variations IReadOnlyList<UIFontVariationCoordinate>

Returns

UIFontGlyphBitmap

RasterizeGlyph(uint, float, float, UIFontHinting, IReadOnlyList<UIFontVariationCoordinate>, UIFontSynthesis)

Rasterizes one glyph at logicalSize times displayScale pixels with optional synthesized bold or oblique.

public UIFontGlyphBitmap RasterizeGlyph(uint glyphId, float logicalSize, float displayScale, UIFontHinting hinting, IReadOnlyList<UIFontVariationCoordinate> variations, UIFontSynthesis synthesis)

Parameters

glyphId uint

logicalSize float

displayScale float

hinting UIFontHinting

variations IReadOnlyList<UIFontVariationCoordinate>

synthesis UIFontSynthesis

Returns

UIFontGlyphBitmap

Shape(string, float, TextDirection, string, string, IReadOnlyList<UIFontOpenTypeFeature>, IReadOnlyList<UIFontVariationCoordinate>)

public UIFontShapedRun Shape(string text, float logicalSize, TextDirection direction = TextDirection.Auto, string locale = null, string script = null, IReadOnlyList<UIFontOpenTypeFeature> features = null, IReadOnlyList<UIFontVariationCoordinate> variations = null)

Parameters

text string

logicalSize float

direction TextDirection

locale string

script string

features IReadOnlyList<UIFontOpenTypeFeature>

variations IReadOnlyList<UIFontVariationCoordinate>

Returns

UIFontShapedRun

SupportsCharacter(int)

public bool SupportsCharacter(int unicodeScalar)

Parameters

unicodeScalar int

Returns

bool