Skip to main content

Class SystemFontId

Represents a font installed in the system.

Assembly: Dalamud.dll​
View Source​
Declaration
public sealed class SystemFontId : IFontId, IObjectWithLocalizableName

Implements:
Dalamud.Interface.FontIdentifier.IFontId, Dalamud.Interface.FontIdentifier.IObjectWithLocalizableName

Properties​

EnglishName​

Gets the name, preferrably in English.

View Source​
Declaration
[JsonProperty]
public string EnglishName { get; init; }

LocaleNames​

Gets the names per locales.

View Source​
Declaration
[JsonProperty]
public IReadOnlyDictionary<string, string>? LocaleNames { get; }

Family​

Gets the associated font family.

View Source​
Declaration
[JsonProperty]
public IFontFamilyId Family { get; init; }

Weight​

Gets the font weight, ranging from 1 to 999.

View Source​
Declaration
[JsonProperty]
public int Weight { get; init; }

Stretch​

Gets the font stretch, ranging from 1 to 9.

View Source​
Declaration
[JsonProperty]
public int Stretch { get; init; }

Style​

Gets the font style. Treat as an opaque value.

View Source​
Declaration
[JsonProperty]
public int Style { get; init; }

Methods​

Equals(object?)​

Determines whether the specified object is equal to the current object.

View Source​
Declaration
public override bool Equals(object? obj)
Returns​

System.Boolean: true if the specified object is equal to the current object; otherwise, false.

Parameters​
TypeNameDescription
System.ObjectobjThe object to compare with the current object.

GetHashCode()​

Serves as the default hash function.

View Source​
Declaration
public override int GetHashCode()
Returns​

System.Int32: A hash code for the current object.### ToString() Returns a string that represents the current object.

View Source​
Declaration
public override string ToString()
Returns​

System.String: A string that represents the current object.### AddToBuildToolkit(IFontAtlasBuildToolkitPreBuild, in SafeFontConfig) Adds this font to the given font build toolkit.

View Source​
Declaration
public ImFontPtr AddToBuildToolkit(IFontAtlasBuildToolkitPreBuild tk, in SafeFontConfig config)
Returns​

ImGuiNET.ImFontPtr: The added font.

Parameters​
TypeNameDescription
Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkitPreBuildtkThe font build toolkit.
Dalamud.Interface.ManagedFontAtlas.SafeFontConfigconfigThe font configuration. Some parameters may be ignored.

GetFileAndIndex()​

Gets the file containing this font, and the font index within.

View Source​
Declaration
public (string Path, int Index) GetFileAndIndex()
Returns​

System.ValueTuple<System.String,System.Int32>: The path and index.

Implements​