Docsv3.31.0
Back to API Reference
Class

UniTextSystemFont

sealed
Inherits:UniTextFont

UniTextFont that resolves its font bytes from the host OS at runtime from a per-platform pick (Common / Windows / macOS / Linux / iOS / Android). WebGL is unsupported.

Remarks

A regular font: it participates only when added to a font stack. Automatic gap-filling for codepoints no font covers is a separate, always-on mechanism — SystemFont — independent of this asset. The font and the weight of its cut are picked per platform; FaceInfo, SDF detail multiplier and tile-size offset can be overridden per platform. Each override defaults to an "unset" sentinel; unset overrides use values extracted from the loaded font. Glyph overrides are not supported — they reference indices specific to a particular font file, which a system font does not pin.

Nested Types

S
FaceInfoOverride
Optional FaceInfo override. Every field defaults to the unset sentinel.
E
FontPlatform
S
PlatformConfig
public string ResolvedPath{ get }

Path of the resolved font file, or the CoreText source key on iOS. Null if unresolved.

public string ResolvedFontName{ get }

Catalog display name actually used at runtime. Null if unresolved.

public UniTextSystemFont.FontPlatform ResolvedPlatform{ get }

Platform tab whose configuration drove the resolution.

public bool ResolveFailed{ get }

True if resolution ran without producing a usable font source.

public bool HasFontData{ get }
public UniTextSystemFont.PlatformConfig GetConfig(UniTextSystemFont.FontPlatform p)

Returns the configuration for one platform tab.

public void SetConfig(UniTextSystemFont.FontPlatform platform, UniTextSystemFont.PlatformConfig value)

Replaces one platform tab and invalidates the resolved operating-system font.

public override byte[] CopyFontData()

Creates a managed snapshot of the resolved operating-system font data.

public void Invalidate()

Forces re-resolution on the next access. Call after changing config at runtime.

protected override void OnDisable()
protected override void OnDestroy()
public static const int UnsetInt
public static const float UnsetFloat
Back to API Reference