API Reference

Canvas text rendering component with full Unicode support. Uses CanvasRenderer for rendering within Unity UI Canvas.

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.

Converts positioned glyphs into Unity mesh data for text rendering.

Global settings ScriptableObject for UniText configuration.

Font asset containing glyph data, metrics, and texture atlases for text rendering.

Manages font assets and provides font lookup services for text rendering.

Font face metrics from OpenType/TrueType tables. All metric values are in font design units unless noted otherwise.

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

A glyph: visual representation of a character in a font atlas.

Base class for all text modifiers that alter text appearance or behavior.

Represents a parsed text range with associated tag information.

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

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

[[IGradientProvider]] backed by an explicit [[UniTextGradients]] asset referenced on the modifier. Use this when a single component should resolve gradients from a different catalog than the project-wide one.

[[IObjProvider]] backed by an explicit [[UniTextObjects]] asset referenced on the modifier. Use this when multiple components should share the same inline-object catalog managed as a project asset.

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

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.

Protects content inside backtick-delimited code spans (e.g. `x`, ``x``, ```x```) from being processed by other parse rules. Follows CommonMark §6.1 balanced-run semantics: an N-backtick run is closed by the next N-backtick run of the same length.

Font asset specialized for color emoji rendering using FreeType or browser APIs.

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.

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]].

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.

A pooled array-based implementation of [[IAttributeData]].