Interface: ITextRenderer

Methods

CreateText()

CreateText(text, style): number;

Parameters

Parameter	Type
text	string
style	TextStyle

Returns

number

---

DestroyText()

DestroyText(handle): void;

Parameters

Parameter	Type
handle	number

Returns

void

---

GetTextNaturalSize()

GetTextNaturalSize(handle): 
  | {
  height: number;
  width: number;
}
  | null;

Post-layout rendered text dims in local pixels. Null while metrics aren't ready (e.g. font still loading) — callers should defer the size adoption until next tick.

Parameters

Parameter	Type
handle	number

Returns

| { height: number; width: number; } | null

---

SetText()

SetText(handle, text): void;

Parameters

Parameter	Type
handle	number
text	string

Returns

void

---

SetTextAnchor()

SetTextAnchor(
   handle, 
   anchorX, 
   anchorY
): void;

Parameters

Parameter	Type
handle	number
anchorX	number
anchorY	number

Returns

void

---

SetTextSize()

SetTextSize(
   handle, 
   width, 
   height
): void;

Parameters

Parameter	Type
handle	number
width	number
height	number

Returns

void

---

SetTextStyle()

SetTextStyle(handle, style): void;

Parameters

Parameter	Type
handle	number
style	TextStyle

Returns

void