API Reference

Canvas-space text component. Renders into a [[Canvas]] via [[CanvasRenderer]] with full Unicode support — bidirectional scripts (Arabic, Hebrew), complex shaping (Devanagari, Thai), proper line breaking, color emoji, and a markup system via [[IParseRule]].

World-space text component. Renders via [[UniTextWorldBatcher]] with full Unicode support — bidirectional scripts, complex shaping, color emoji, markup.

Shared base for UniText components — handles text processing (Unicode, BiDi, shaping, line breaking, modifiers, emoji, font fallback, variable fonts). Concrete subclasses supply the rendering backend: [[UniText]] (Canvas) and [[UniTextWorld]] (world-space).

Processes Unicode text through script analysis, BiDi reordering, shaping, and layout.

Positions glyphs within the layout bounds based on line breaking results and alignment settings.

Container for all intermediate and final buffers used during text processing.

Serialized ScriptableObject wrapper around a runtime font [[Core]]. Stores font bytes, faceInfo and editor-tweakable settings; instantiates a Core on first [[Runtime]] access. The Core does all glyph work and is the type consumed by shaping/atlas code paths.

Ordered list of font families plus an optional fallback stack. The first family's primary provides strut metrics (line height, ascent, descent). Face matching uses pre-computed lookup tables with CSS Fonts Level 4 §5.2 weight matching.

A font family: primary font plus optional variant faces (Bold, Italic, Variable, etc.).

Owns codepoint→font resolution for a text object: composes the family chain from the assigned font and font stack, walks it (plus emoji and the always-on [[SystemFont]] fallback) to pick a runtime per codepoint, and stores [[Core]] instances so worker-thread companions and the emoji singleton (both plain Core, no Unity asset) flow through the same code path.

One variable-font axis pinned to a custom default value, keyed by its OpenType tag (4-char tag packed big-endian, same bits as the HarfBuzz uint tag).

Plain runtime for a font: holds FT face, glyph table, lookup dictionaries, curve cache, atlas pipeline. Constructable on worker threads (no Unity object lifecycle).

Base class for text modifiers — pieces of logic that alter appearance, layout, or behavior of a text range matched by an [[IParseRule]].

Serializable container that links a modifier with its parse rule. Tracks registration state and ownership to prevent bugs.

Shareable, project-asset container of [[Style]] entries that components apply in bulk via [[AddStylePreset]] or via [[GlobalStylePreset]].

Represents a parsed text range with associated tag information.

Defines an inline object (UI prefab) that can be embedded within text flow.

Sets horizontal alignment, justify mode, and last-line alignment for the paragraphs it covers. Apply whole-text or per range/tag — each paragraph can differ.

Interface for custom text parsing rules that identify modifier application ranges.

Universal tag parse rule configured via a serialized tag name. Replaces all individual tag parse rule classes (BoldParseRule, ColorParseRule, etc.).

Base class for parsing XML-style markup tags (e.g., <b>, <color=#FF0000>).

Combines multiple parse rules into a single rule.

Matches literal string patterns and optionally replaces them.

Escapes a single ASCII punctuation character preceded by \. Example: \* becomes a literal * and is protected from any other parse rule.

Color emoji runtime. Plain [[Core]] subclass — not a ScriptableObject. Singleton; auto-loads the platform's system emoji font on first [[Instance]] access.

Utility for locating system emoji fonts across platforms.

Provides access to Unicode character properties and the global data provider.

Unicode General Category property values.

Interface for script-specific word segmenters that inject break opportunities into SA-class (Complex Context Dependent) text runs.

Specifies the type of line break opportunity according to UAX #14.

A contiguous run of positioned glyphs within a single line whose clusters fall inside a queried range. Bounds are in local mesh coordinates (relative to the text origin), with X clamped to the line's visible content extent (trailing whitespace excluded per CSS Text §4.1.3 via [[width]]).

Specifies the base text direction for bidirectional text processing.

Text shaper that converts codepoints to positioned glyphs via HarfBuzz. Performs full OpenType shaping (GSUB/GPOS) including kerning, ligatures and mark positioning.

Gradient projection mode. [[Linear]] projects vertex positions onto an axis, [[Radial]] uses distance from the range's centre, [[Angular]] sweeps a conic from the centre.

Represents a shaped glyph with positioning information from the shaping engine.

Represents a text run after shaping, with glyph information and metrics.

Result of a shaping operation containing glyphs and metrics.

Marks a string field as a default parameter for a parse rule. Draws a toggle + rich parameter fields based on the paired modifier's ParameterFieldAttribute.

Hides a type from the TypeSelector dropdown while keeping it deserializable.

Serializable base for [[INamedCatalog{TEntry}]] implementations that delegate resolution to an explicit ScriptableObject asset reference — useful when multiple components should share the same catalog managed as a project asset.

Resolves named entries by case-insensitive name. Used by every "named catalog" feature in UniText (gradients, inline sprites, inline-object prefabs) so the same set of providers — inline list, shared asset, custom code — composes across all of them.

Extension methods for parsing [[Index]] from string representation.

Serializable base for [[INamedCatalog{TEntry}]] implementations that keep their entries inline on the owning modifier — edited in the inspector or mutated at runtime via [[SetEntries]], [[Add]], [[Remove]].

Backend-agnostic input reads. Calling [[Input]] directly throws an [[InvalidOperationException]] every frame when the project's active input handling is set to the Input System package only; these route to Keyboard.current / Mouse.current in that configuration, to legacy Input otherwise.

Abstract ScriptableObject base for named-entry catalogs. Subclasses give the catalog a concrete entry type, a CreateAssetMenu path, and (optionally) a payload validity filter for editor enumeration.