Docsv2.12.12
Back to API Reference
Class

TextHighlightRenderer

abstract

Backend-agnostic view surface for TextHighlighter visuals.

Remarks

Built-in implementations: CanvasHighlightRenderer wraps RangeHighlightGraphic for UniText, while WorldHighlightRenderer wraps a MeshRenderer-based quad mesh for UniTextWorld. A TextHighlighter subclass picks one of these (or a custom subclass) per backend via its CreateHighlightRenderer(UniText,...) / CreateHighlightRenderer(UniTextWorld,...) overloads and drives the result with the same lifecycle regardless of backend.

Derived Types(2)

Types that inherit from TextHighlightRenderer.

C
CanvasHighlightRenderer
Canvas-backed [[TextHighlightRenderer]] — wraps a child GameObject with [[RangeHighlightGraphic]] anchored to the owning [[UniText]]. Z-order is managed via sibling index (above = last, behind = first).
C
WorldHighlightRenderer
World-space [[TextHighlightRenderer]] — wraps a child GameObject with [[MeshFilter]] + [[MeshRenderer]] and builds quads from rects directly into a dynamic [[Mesh]]. One shared material ([[Highlight]]) serves every instance; color travels through vertex colors.
public Color Color{ get; set }

Solid color applied to every rect. Setting this updates visuals immediately.

public abstract void SetRects()

Replaces the rectangles rendered by this surface. Rects are in text-local space.

public abstract void Clear()

Clears all rectangles. The surface stays alive but draws nothing.

public abstract void Destroy()

Permanently destroys the backing GameObject / resources.

Back to API Reference