TextComponentOptions

Defined in: renderer/src/TextComponent.ts:22

Options for creating a TextComponent.

Properties

alpha?

optional alpha?: number

Defined in: renderer/src/TextComponent.ts:51

Alpha (opacity). Default: 1.

---

anchor?

optional anchor?: object

Defined in: renderer/src/TextComponent.ts:43

Anchor point (0-1). Default: { x: 0, y: 0 } (top-left).

x

x: number

y

y: number

---

bitmap?

optional bitmap?: BitmapTextOption

Defined in: renderer/src/TextComponent.ts:33

Render with a bitmap font instead of canvas-rasterised Text — the pixel-art escape hatch. true bakes a dynamic font from style; { font } uses an installed/loaded font by name (size overrides the glyph size). See BitmapTextOption.

---

layer?

optional layer?: string

Defined in: renderer/src/TextComponent.ts:45

Render layer name. Default: “default”.

---

resolution?

optional resolution?: number

Defined in: renderer/src/TextComponent.ts:41

Per-text render resolution. Mirrors the Pixi v8 Text constructor option — note resolution is NOT a TextStyle property in v8, so setting it here is the only way to get crisp canvas text without a prototype patch. Ignored when bitmap is set (bitmap resolution is fixed at font-bake time).

---

style?

optional style?: TextStyleOptions

Defined in: renderer/src/TextComponent.ts:26

Text style — forwards to PixiJS TextStyleOptions (CSS-like font properties).

---

text

text: string

Defined in: renderer/src/TextComponent.ts:24

The text string to render.

---

tint?

optional tint?: number

Defined in: renderer/src/TextComponent.ts:49

Tint color.

---

visible?

optional visible?: boolean

Defined in: renderer/src/TextComponent.ts:47

Initial visibility. Default: true.