pixijs/pixijs-skills

pixijs-scene-text

Use this skill when rendering text in PixiJS v8.

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/pixijs/pixijs-skills --skill pixijs-scene-text

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

PixiJS has five text-rendering classes that cover different trade-offs between styling, performance, and animation. Text renders to a canvas for full CSS-style fidelity. BitmapText reads from a pre-generated atlas for cheap updates. HTMLText renders an HTML fragment via SVG <foreignObject> for rich markup. SplitText and SplitBitmapText wrap the first two classes and expose per-character, per-word, and per-line containers for animation.

Assumes familiarity with pixijs-scene-core-concepts. All text classes are leaf nodes; they cannot have children. Wrap multiple text instances in a Container to group them.

Quick Start

ts
const text = new Text({
  text: "Hello PixiJS",
  style: {
    fontFamily: "Arial",
    fontSize: 36,
    fill: 0xffffff,
    stroke: { color: 0x4a1850, width: 5 },
    dropShadow: { color: 0x000000, blur: 4, distance: 6 },
  },
});

text.anchor.set(0.5);
text.x = app.screen.width / 2;
text.y = 40;

app.stage.addChild(text);

All text classes use options-object constructors; positional (string, style) from v7 is not supported.

Related skills: pixijs-scene-core-concepts (leaves, transforms), pixijs-assets (font loading), pixijs-performance (BitmapText tradeoffs), pixijs-color (FillInput for fill/stroke), pixijs-scene-graphics (gradients and patterns reused via FillInput).

Variants

VariantUse whenTrade-offsReference
TextHigh-quality static or infrequent-update labelsExpensive to update (canvas re-draw + GPU upload)references/text.md
BitmapTextScores, timers, gameplay labels, anything that changes every frameLimited styling; fixed glyph atlas; requires MSDF for crisp scalingreferences/bitmap-text.md
HTMLTextRich formatted text, mixed styles, real HTML tagsAsync rendering (one frame delay); similar update cost to Textreferences/html-text.md
SplitTextPer-character animation with rich stylingEach char is a full Text; expensive for long stringsreferences/split-text.md
SplitBitmapTextPer-character animation on long strings or dynamic contentInherits BitmapText limitations (glyph atlas, no MSDF-free crispness)references/split-bitmap-text.md

When to use what

  • "I need a styled static label" → Text. Use for titles, menus, dialog, error messages. See references/text.md.
  • "I need a score or timer that updates every frame" → BitmapText. Updates only reposition quads; no canvas re-draw. See references/bitmap-text.md.
  • "I need mixed formatting with `<b>`, `<i>`, `<br>`" → HTMLText. Real HTML/CSS rendering via SVG. See references/html-text.md.
  • "I need inline colored tags like `<red>Warning:</red>`" → Text or HTMLText with tagStyles. Both support it.
  • "I need to animate each character individually" → SplitText for short strings, SplitBitmapText for long strings or many instances. See references/split-text.md / references/split-bitmap-text.md.
  • "I need CJK / Arabic / emoji-heavy text" → Text or HTMLText. BitmapText fails because the glyph set is too large for a single atlas.
  • "I need a custom font" → Load via Assets.load({ src: 'font.woff2', data: { family: 'MyFont' } }) first, then set style.fontFamily: 'MyFont'. Works for Text and HTMLText.

Update cost comparison

Update triggerTextBitmapTextHTMLTextSplitTextSplitBitmapText
Changing .textHighVery lowHighVery high (N text re-renders)Low (N quad repositions)
Changing .styleHighMediumHighVery highMedium
Moving (.x, .y)FreeFreeFreeFreeFree
Rotating / scalingFreeFreeFreeFreeFree

"Free" = normal Container transform cost. "High" = new canvas draw + GPU upload. "Very low" = quad reposition only. Update strings that change per-frame only on BitmapText or SplitBitmapText.

Quick concepts

  • Options-object constructors. Every v8 text class uses new Text({ text, style, ... }). The v7 (string, style) form is removed.
  • `tagStyles`. Text and HTMLText support per-tag styling via style.tagStyles. Tags are only parsed when tagStyles has entries; otherwise < is treated literally.
  • `BitmapFont.install`. Pre-generates an atlas before you create any BitmapText. Without install, the first BitmapText with a new fontFamily generates the atlas lazily.
  • MSDF fonts. Multi-channel Signed Distance Field fonts stay sharp at any size. Generate with external tools (e.g., msdf-bmfont), load via Assets.load('font.fnt'). Requires import 'pixi.js/text-bitmap' in custom builds.

Common Mistakes

[HIGH] Updating Text.text every frame

Wrong:

ts
app.ticker.add(() => {
  scoreText.text = `Score: ${score}`;
});

Correct:

ts
const scoreText = new BitmapText({ text: "Score: 0", style });
app.ticker.add(() => {
  scoreText.text = `Score: ${score}`;
});

Every Text update re-rasterizes the whole string. Use BitmapText for any value that changes per-frame.

[HIGH] Positional constructor args

Wrong:

ts
const text = new Text("Hello", { fontSize: 24 });

Correct:

ts
const text = new Text({ text: "Hello", style: { fontSize: 24 } });

v8 removed the (string, style) form. All text classes use options objects.

[HIGH] Not importing pixi.js/text-bitmap in custom builds

Under skipExtensionImports: true or aggressive tree-shaking, Assets.load('font.fnt') silently returns raw data unless you add import 'pixi.js/text-bitmap'. The standard import { ... } from 'pixi.js' bundle includes the extension.

[MEDIUM] Adding children to a text instance

Every text class sets allowChildren = false. Wrap in a Container to group text with other content.

API Reference

按任务相关推荐

来自同一仓库

更多 Skills

全部 Skills
pixijs
社区

pixijs

PixiJS v8 (pixi.js) reference. Use it before writing, fixing or porting any PixiJS code, from a one-line fix to a whole app or game. Routes to topic files: Application (app.init, resizeTo, resolution), Container scene graph (addChild, zIndex, RenderLayer, mask, destroy), Sprite, Texture, AnimatedSprite, TilingSprite, NineSliceSprite, Graphics (fill, stroke, FillGradient, SVG, SmoothGraphics), Text, BitmapText, HTMLText, SplitText, Mesh, MeshRope, ParticleContainer, Assets (load, bundles, Sprites

1小时安装量
2
GitHub Stars
389
最近更新
11月12日
pixijs
社区

pixijs-3d

Use this skill whenever writing or editing code that uses PixiJS 3D (@pixi/3d): scenes, View3D, Mesh3D, Model3D, lights, shadows, cameras, OrbitCamera, FPSCamera, materials, Material3D, textures, glTF models and animation, BatchedMesh3D instancing, picking and pointer events, post-processing (bloom, SSAO), particles, render to texture, ContainerTexture, custom shader bits, 2D HUD over 3D, Sprite3D billboards, tone mapping and HDR environments, scene graph and transforms (local and world space, r

1小时安装量
2
GitHub Stars
389
最近更新
11月12日
pixijs
社区

pixijs-accessibility

Use this skill when adding screen reader and keyboard navigation to PixiJS v8 apps. Covers AccessibilitySystem options (enabledByDefault, debug, activateOnTab, deactivateOnMouseMove), per-container accessibility properties, shadow DOM overlay, mobile touch-hook activation. Triggers on: accessibility, a11y, screen reader, ARIA, keyboard navigation, tab order, AccessibilitySystem, accessibleTitle, accessibleHint, tabIndex, accessibleChildren.

1小时安装量
3
GitHub Stars
365
最近更新
10月1日
pixijs
社区

pixijs-application

Use this skill when creating and configuring a PixiJS v8 Application. Covers new Application() + async app.init() options (width, height, background, antialias, resolution, autoDensity, preference, resizeTo, autoStart, sharedTicker, canvas, useBackBuffer, powerPreference, eventFeatures, accessibilityOptions, gcActive, bezierSmoothness, webgl/webgpu/canvasOptions per-renderer overrides), app.stage/renderer/canvas/screen/domContainerRoot access, ResizePlugin, TickerPlugin, CullerPlugin (cullable,

1小时安装量
3
GitHub Stars
365
最近更新
10月1日