Docsv3.31.0
Back to API Reference
Class

UniTextFont.Core

Nested inUniTextFont
Implements:IDisposable

Plain runtime for a font: owns face access, glyph tables, lookup dictionaries, curve cache and atlas pipeline. Constructable on worker threads (no Unity object lifecycle). Dispose instances constructed directly; a UniTextFont owns and disposes the runtime exposed by its asset.

Derived Types(1)

Types that inherit from UniTextFont.Core.

C
ColorFontCore
Runtime for a color font (CBDT/sbix bitmap or COLRv0/COLRv1 vector). Plain UniTextFont.Core subclass — not a ScriptableObject; constructable on worker threads. Owns the color-glyph rasterization pipeline: color-format detection, FreeType/Blend2D rendering into the shared color atlas, and color glyph metrics. The system emoji font (EmojiFont) and the UniTextColorFont asset are both built on this base. A glyph an effect decorates also gets a silhouette field in the SDF atlas, derived from the same bitmap's alpha when it is packed.
public bool HasFontData{ get }
public int FontDataHash{ get }

Process-unique runtime identity, so distinct font sources and faces can never alias in shaping or atlas registries.

public int RawFontDataHash{ get }

Raw bytes-derived hash. Subclasses override to forward to their bytes source.

public FaceInfo FaceInfo{ get; set }

Face metrics in design units; their units per em is always UnitsPerEm.

public int UnitsPerEm{ get; set }
public float FontScale{ get; set }
public bool ParticipatesInNormalization{ get; set }
public float ItalicStyle{ get; set }
public int SpacingOffset{ get; set }
public int SpaceAdvance{ get; set }
public float FakeBoldWeight{ get; set }
public int PixelsPerEm{ get }

Native pixel grid in pixels per em; 0 for a distance-field font. Glyphs of a pixel font rasterize once, one atlas texel per font pixel, and render with nearest sampling and hard edges.

public bool IsPixel{ get }

True when glyphs rasterize on the font's native pixel grid (PixelsPerEm).

public bool SnapToPixelGrid{ get; set }

Whether glyph origins of a pixel font, and every translation an effect or animation applies to its quads, round to whole font pixels; meaningless while IsPixel is false.

public string Name{ get; set }

Worker-thread-safe display name.

public int AtlasPadding{ get }
public bool IsColor{ get }
public bool IsVariable{ get }
public Dictionary<long,Glyph> GlyphLookupTable{ get }

(varHash48, glyphIndex) → atlas-resident glyph. Lazy-built on first access.

[ctor]public Core(byte[] bytes, FaceInfo faceInfo, int unitsPerEm, float fontScale, float sdfDetailMultiplier, int tileSizeOffset, float italicStyle, int spacingOffset, float fakeBoldWeight, List<UniTextFont.GlyphOverride> glyphOverrides = null, string name = null, List<UniTextFont.AxisDefault> axisDefaults = null, int spaceAdvance = SpaceAdvanceUninitialized, int pixelsPerEm = 0, bool snapToPixelGrid = true)

Constructs an independently owned runtime from font bytes and the rendering settings normally supplied by the UniTextFont wrapper. The byte array is shared without copying and must not be modified while the runtime is alive. Safe to call from worker threads; the caller must dispose it.

public virtual byte[] CopyFontData()

Creates a managed snapshot of the complete raw font file.

public virtual int GetCachedInstanceId()
protected IntPtr EnsureFTFace()
protected void ReleaseFTFace()
public virtual UniTextFontError LoadFontFace()
public virtual void ReadFontDefinition()

Creates the runtime glyph lookup table when it does not exist yet; existing entries stay.

public uint GetGlyphIndexForUnicode(uint unicode)
public virtual bool HasGlyphInAtlas(uint glyphIndex, UniTextRenderMode mode)

Returns whether the glyph has an entry in the selected distance-field atlas for this font's default variation.

public virtual void ClearDynamicData()
public virtual void Dispose()

Releases font faces, outline sources, curve caches, batch buffers, atlas entries and styled fallback clones, and unregisters from the live registry. Idempotent.

Back to API Reference