pixijs
Skill372 starsChanged 7 months agoMITView on GitHub
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, Spritesheet, fonts, video), Ticker and onRender, events (eventMode, pointertap, drag, hitArea), filters and shaders (BlurFilter, Filter.from, GlProgram), blendMode and erasing into a RenderTexture, generateTexture, cacheAsTexture, Color, Point, Matrix, DOMContainer, GifSprite, HTMLSource, accessibility, performance and teardown, WebGL/WebGPU/Canvas renderers, Web Workers, custom builds, project setup, migration from v7.
5 other projects use a version of this.
Adopted by
Most recently taken up by
- delorenj/skillstheir own version, first seen Nov 7, 2026
- jammyfu/open-game-skillstheir own version, first seen Oct 11, 2026
- WordPress/desktop-modetheir own version, first seen Oct 8, 2026
- talesofai/cohubtheir own version, first seen Oct 8, 2026
- pixijs/pixijstheir own version, first seen Oct 8, 2026
Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 5
- pixijs/pixijs★ 49ksame name
- talesofai/cohub★ 585same name
- WordPress/desktop-mode★ 280same name
- delorenj/skills★ 17same name
- jammyfu/open-game-skills★ 13same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository3 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- pixijs-3dSkill
The file
We split this skill into the rules it gives an agent
8 rules. About 0 are common, 1 is distinctive, and 7 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
7
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 13
No row fits: scan references/index.md (sub-pages, long-tail keywords, error strings), then the project's local PixiJS docs.
- Very specific: line 28
Read canvas pixels from a listener at UPDATE_PRIORITY.UTILITY, which runs after the render.
- Very specific: line 37
After drawing into a source canvas, call texture.source.update().
- Very specific: line 42
Call play() after each anim.textures = ...
- Very specific: line 62
All particles share one texture source (frames of one atlas).
- Very specific: line 85
Stop page scroll with a native app.canvas.addEventListener('wheel', (e) => e.preventDefault(), { passive: false }).
- Very specific: line 90
Add a mask as a child of the masked Container.
- Very specific: line 98
Call app.destroy() after init resolves (in React effects, chain it on the init promise).
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Read before you write
- List the files. Write down every router row below that your task touches: each class you construct, options object you pass, effect you build and symptom you fix. A whole app usually lists four to eight (an eraser paint app: application, assets, scene-sprite, events, blend-modes; a game: application, assets, scene-sprite, events, ticker, scene-text).
- Read each listed file before you write the code for that part, even for a one-line change. Open the file itself; a Grep hit is a fragment that drops the rule and the exception beside it. Each topic file links to its sub-pages for rarer branches.
- Done when every file on your list has been opened. Then check your code against the pitfall group below for each feature you built.
No row fits: scan references/index.md (sub-pages, long-tail keywords, error strings), then the project's local PixiJS docs.
For a signature or option this skill doesn't cover, fetch the class's API page: https://pixijs.download/release/docs/<module>.<Class>.html.md (app.Application, scene.Graphics, rendering.Texture, assets.Assets). To find a class's module, look it up in https://pixijs.download/release/docs/llms.txt.
Pitfalls that fail silently
Each line is the fix; its link owns the rule and the code. These run without errors and draw the wrong thing, and a Vite build doesn't type-check, so run npx tsc --noEmit to catch wrong option names.
App setup and the frame loop
const app = new Application(); await app.init({ ... }). Constructor options are ignored; untilinitresolvesapp.rendererisundefinedandapp.canvas/app.screenthrow. application- Top-level
awaitfailsvite buildon Vite 6 and older; wrap init in an async IIFE. create - With
resizeTo, lay out inapp.renderer.on('resize', (w, h) => ...); your ownwindowresize listener reads the oldapp.screen. An element target also needsnew ResizeObserver(() => app.queueResize()). application - Ticker callbacks receive the
Ticker:app.ticker.add((t) => (s.x += 2 * t.deltaTime)).deltaTimeis ~1 per 60 fps frame,deltaMSis milliseconds. ticker app.ticker.update()already renders, even withautoStart: false; skip the extraapp.render(). ticker- Per-object frame logic:
obj.onRender = () => { ... }(replaces v7updateTransformoverrides); it also runs while the object is invisible. Name subclass methods anything but_onRender. ticker - Read canvas pixels from a listener at
UPDATE_PRIORITY.UTILITY, which runs after the render. ticker
Loading assets and textures
await Assets.init({ basePath, manifest })before the firstload,loadBundleorbackgroundLoad; a laterinitis dropped. assetsAssets.load([a, b])resolves an object keyed by URL or alias: readres[a]. assets- A URL with no file extension (
?id=,blob:, API route) needsAssets.load({ src, parser: 'texture' }); without it the result isnullwith only a warning. Audio files have no loader and also resolvenull; play sound with@pixi/soundorHTMLAudioElement. assets Texture.from(url)andSprite.from(url)read the cache only (v7 fetched):await Assets.load(url)first. scene-sprite- Wrap a
TextureSource(CanvasSource,texture.source):Sprite.from(source)ornew Sprite(Texture.from(source));new Sprite(source)draws nothing. scene-sprite - Show another region with
sprite.texture = new Texture({ source, frame: new Rectangle(...) }), or create the texture withdynamic: trueand calltexture.update(). scene-sprite - After drawing into a source canvas, call
texture.source.update(). sprite - Per-asset
data(scaleMode,resolution) applies on the first load of asrconly; settexture.source.scaleModeon the result instead. assets
Sprites and animation
AnimatedSprite:animationSpeedis frames per 60 fps tick (12 fps is0.2), and it needsautoPlay: trueorplay(). It runs onTicker.shared, soapp.ticker.stop()doesn't pause it. animated-sprite- Call
play()after eachanim.textures = ...swap; replay a finished one-shot withgotoAndPlay(0). animated-sprite - Rotate or scale about a point with
origin;pivotalso moves the object, andanchor(0-1) shifts only the texture. scene-sprite
Graphics
- Shape first, then style:
new Graphics().rect(0, 0, 100, 50).fill(0xff0000).stroke({ width: 2, color: 0x000000 }).beginFill,drawRectandlineStyleare v7. scene-graphics FillGradient: options object, every colour stop set before the first draw,textureSpace: 'global'for pixel coordinates (the default'local'is 0-1 across the shape). scene-graphics- Draw-time transforms apply in call order, the reverse of Canvas 2D:
rotateTransform(a).translateTransform(x, y). scene-graphics - Stroke
alignmentis1inside,0outside (inverted from v7). scene-graphics - Animate a stable
Graphicsby its transform;clear()and redraw every frame re-tessellates. scene-graphics
Drawing into textures (paint, eraser, scratch-off, fog of war, baking)
- The render root's own
blendModeis ignored: put an'erase'brush inside a plainContainerand pass the wrapper torenderer.render({ container: wrapper, target, clear: false }).clear: falsekeeps earlier strokes. blend-modes 'erase'clears everything under it in the same target, background included; give the erasable layer its ownRenderTextureand erase into that. blend-modes- Brush coordinates are texture pixels:
sprite.toLocal(e.global)plus the anchor offset. blend-modes generateTexture({ target, frame: new Rectangle(...) }):frameis a realRectangle(a plain object throwscopyTo is not a function), and the capture ignores the target's own position, scale and rotation. renderers- A
cacheAsTexture(true)container shows changes to its children only afterupdateCacheTexture(). performance
Particles
- Fill a
ParticleContainerwithaddParticle(...particles); theparticlesoption draws nothing untilupdate(). Type itnew ParticleContainer<Particle>(...)to reachtintandalpha. scene-particle-container - Mark every property you change per frame in
dynamicProperties:position,rotation,vertex(scale, anchor),color(tint, alpha),uvs(texture). A static one changes only afterupdate(), and v7'stint/scalekeys are ignored. scene-particle-container - All particles share one texture source (frames of one atlas). Give the container
boundsArea(its bounds are empty, so culling and filters skip it) andhitAreapluseventModefor pointer events. scene-particle-container
Filters and blend modes
- Assign a new array to change filters:
c.filters = [...(c.filters ?? []), blur]. filters - Custom GLSL:
Filter.from({ gl: { vertex: defaultFilterVert, fragment }, resources }). In the fragment sampleuTexture, get 0-1 coordinates fromvTextureCoord * uInputSize.xy / uOutputFrame.zw(bothhighp), and keep colour premultiplied (invert withvec4(c.a - c.rgb, c.a)). filters - On the WebGPU renderer (
preference: 'webgpu') every filter needs agpuprogram too, or all filters on that container are skipped. The Canvas renderer skips filters. filters - Effects that reach past the shape (glow, wave, outline) need
padding; a full-screen stage filter needsapp.stage.filterArea = app.screen; useresolution: 'inherit'on a high-DPI renderer. filters DisplacementFiltertakes aSpritethat is on the stage; animate the distortion by moving that sprite (map textureaddressMode = 'repeat'). ATilingSprite'stilePositionis never read. filters- A filtered container composites with its last filter's
blendMode:new BlurFilter({ strength: 8, blendMode: 'add' }). blend-modes - Modes beyond
normal/add/multiply/screen/erase/min/maxneedimport 'pixi.js/advanced-blend-modes'and, on WebGL,app.init({ useBackBuffer: true }). blend-modes
Text
new Text({ text, style: { fill: 0xffffff } }): the default fill is black, invisible on the default black background. scene-text- Strings that change every frame (score, timer, FPS) go in
BitmapText; eachTextchange redraws a canvas and re-uploads it. scene-text - Load web fonts with
await Assets.load({ src, data: { family } })before creating text;HTMLTextsees only fonts loaded this way. html-text - Raise
style.paddingwhen a stroke or drop shadow is clipped. text
Input
- Give every listening object
eventMode = 'static'(the default'passive'never fires its own listeners) andcursor = 'pointer'(v7buttonMode). events - Clicks on empty canvas:
app.stage.eventMode = 'static'andapp.stage.hitArea = app.screen. A plainContaineris hit only on its children; give it ahitAreato cover the gaps. events visible = falseandrenderable = falseremove an object from hit testing; an invisible target usesalpha = 0or ahitArea. scene-container- Buttons listen to
pointertap(clickis mouse only,taptouch only); a double click ise.detail === 2. events - Drag with
globalpointermove(plainpointermovefires only over the object), end onpointerupandpointerupoutside, convert withparent.toLocal(e.global), and keep points withp.copyFrom(e.global)(event objects are reused). events - Stop page scroll with a native
app.canvas.addEventListener('wheel', (e) => e.preventDefault(), { passive: false }). events
Scene order, coordinates and masks
zIndexorders siblings only and sorts at the next render; callparent.sortChildren()before readingchildren. scene-container- Depth-sort across parents with
new RenderLayer({ sortableChildren: true })andlayer.attach(obj); attach again after reparenting, and hide or move the objects themselves (the layer's ownvisible,alphaand position do nothing). layers - Add a mask as a child of the masked
Container; aSpritemask reads the red channel unlesssetMask({ mask, channel: 'alpha' }). masking - Map pointers into rotated or scaled containers with
container.toLocal(e.global);getBounds()returnsBounds, so hit-test withgetBounds().rectangle.contains(x, y). scene-container Matrixmethods apply in call order anda.append(b)appliesbfirst; Container-style isscale().rotate().translate(), applied withsetFromMatrix. math- Copy points with
copyFrom(p)orset(x, y);pixi.js/math-extrasmethods return a new point, so update in place withpos.add(v, pos). math Colorreads a plainnumber[]as 0-1 ([180, 60, 90]is white); pass 0-255 as aUint8Array, and alpha as'#rrggbbaa'(0xRRGGBBAAthrows). color
Teardown
- Destroy a subtree with
destroy({ children: true })and free loaded files withAssets.unload(key).destroy(true)also destroys shared textures, atlases andGraphicsContexts, and every later render of another user throws. scene-container - Call
app.destroy()afterinitresolves (in React effects, chain it on the init promise); passreleaseGlobalResources: truewhen re-creating an app in the same tab. application - Destroy textures you create (
generateTexture, canvases) withtexture.destroy(true); defer a destroy from insideonRenderwithapp.ticker.addOnce(() => obj.destroy()). performance, scene-container
Renderers and builds
Applicationpicks WebGL unlesspreference: 'webgpu'. The Canvas renderer skips filters and draws nothing forMesh. rendererspixi.js/math-extras,pixi.js/prepare,pixi.js/gifandpixi.js/advanced-blend-modeswork only after a side-effect import; withskipExtensionImports: true, also importpixi.js/events,pixi.js/filters,pixi.js/accessibilityandpixi.js/dom. environments
Reference router
Foundations
| Reference | Read when your code touches... |
| application | Application, app.init() options and defaults, app.stage/renderer/canvas/screen, resizeTo, queueResize, layout on resize, resolution/autoDensity/HiDPI (also after init), autoStart, sharedTicker, app.start()/stop(), CullerPlugin, Application plugins, app.destroy() and React StrictMode cleanup. |
| core-concepts | Choosing WebGL/WebGPU/Canvas, autoDetectRenderer, checking the backend, renderer.render() options (clear, transform, target), RenderTexture/RenderTarget, generateTexture, systems and pipes, renderer loaders, Three.js interop (resetState), context and device loss. |
| ticker | Per-frame logic: app.ticker.add, deltaTime vs deltaMS, UPDATE_PRIORITY and frame order, maxFPS/minFPS, speed, onRender (v7 updateTransform), Ticker.shared, a manual loop with ticker.update(), pausing. |
| environments | Web Workers and OffscreenCanvas, Node/SSR/headless, strict CSP (pixi.js/unsafe-eval), DOMAdapter and custom fetch (auth headers), custom or tree-shaken builds (skipExtensionImports, side-effect imports), bundle size. |
| create | Scaffolding with npm create pixi.js and its templates, adding pixi.js to an existing project, tsconfig for TypeScript 5-7, Vite top-level-await build errors, @webgpu/types conflicts. |
| migration-v8 | Porting a whole v7 codebase: @pixi/* imports, BaseTexture, DisplayObject, settings and utils, renderer.plugins, renamed options and enums (SCALE_MODES, BLEND_MODES). For one API, its topic file is enough. |
Scene
| Reference | Read when your code touches... |
| scene-core-concepts | The scene graph as a whole: containers vs leaves, render order, which class to use; sub-pages for coordinate spaces and worldTransform, render groups (isRenderGroup, panning a world), constructor options, RenderLayer (depth sort across parents), and masks (mask, setMask, inverse, sprite-mask channel). |
| scene-container | Container: addChild/removeChildren/reparentChild, pivot vs origin, hiding (visible/renderable/alpha), zIndex and sortChildren(), getBounds, toGlobal/toLocal, setSize, container events, onRender, destroy options. |
| scene-sprite | Sprite, Texture vs TextureSource, Sprite.from/Texture.from, sub-textures and frame, dynamic and canvas textures, shared-texture destroy; AnimatedSprite (speed, swapping or replaying animations, onComplete), NineSliceSprite (panels, borders), TilingSprite (tilePosition, scrolling backgrounds). |
| scene-graphics | Graphics beyond a colour-filled shape: paths, holes (cut), strokes, FillGradient, FillPattern, texture fills, draw-time transforms, GraphicsContext sharing, SVG import and export (svg(), graphicsContextToSvg), hit testing, smooth edges without MSAA (SmoothGraphics), dashed lines (DashLineShader), v7 beginFill/lineStyle ports. |
| scene-text | Text, TextStyle, BitmapText (BitmapFont.install, .fnt, MSDF), HTMLText (fonts, tag styles), SplitText/SplitBitmapText, per-frame text cost, shaped scripts. |
| scene-mesh | Mesh, MeshGeometry (positions, uvs, indices, topology), MeshSimple, MeshPlane, MeshRope (trails), PerspectiveMesh, UVs and addressMode, mesh hit testing. |
| scene-particle-container | ParticleContainer, Particle, dynamicProperties, update(), emitters and particle pools, fading or tinting particles, pointer events on particles. |
| scene-dom-container | HTML elements over the canvas: DOMContainer, inputs and iframes, click-through pointer-events, domContainerRoot, removing the element. |
| scene-gif | Animated GIFs: pixi.js/gif, GifSprite, GifSource, GIF frame rate, cleanup. |
| html-source | Live HTML/DOM rendered into a texture (experimental HTML-in-Canvas): HTMLSource, ElementImageSource, pixi.js/html-source, requestPaint. |
Utilities
| Reference | Read when your code touches... |
| assets | Assets.init/load/add/get/unload, load result shapes, extension-less or blob: URLs (parser), retries and errors, bundles, manifests, background loading, progress bars, spritesheets, fonts, video, SVG, compressed textures, @2x resolution. |
| events | Pointer, mouse, touch, wheel: eventMode, pointertap vs click/tap, double click, propagation and capture, hitArea, interactiveChildren, clicks on empty canvas, drag (globalpointermove), cursor, FederatedPointerEvent, eventFeatures. |
| math | Point/ObservablePoint (set, copyFrom), Matrix (order, append/prepend, decompose, setFromMatrix), Rectangle and hit-area shapes, pixi.js/math-extras vector methods, DEG_TO_RAD. |
| color | Color and ColorSource: input ranges (hex with alpha, arrays, Uint8Array), conversions (toHex, toRgba, toNumber), tint and alpha, premultiply, v7 utils.string2hex. |
| accessibility | Screen readers and keyboard navigation: accessible, accessibleTitle, tabIndex, accessibilityOptions, no overlay element appearing. |
Effects and rendering
| Reference | Read when your code touches... |
| blend-modes | Any blendMode (add, multiply, screen, erase), an eraser, scratch-off or fog of war, painting into a RenderTexture, blend mode of the render root or of a filtered container, overlay and other advanced modes. |
| filters | BlurFilter, ColorMatrixFilter, DisplacementFilter, NoiseFilter, AlphaFilter, custom Filter.from (GLSL, WGSL), filter uniforms, padding, filterArea, resolution, blendRequired, pixi-filters, multi-pass filters (bloom). |
| custom-rendering | Custom shaders on a Mesh: Shader.from, GlProgram/GpuProgram, UniformGroup and uniform types, textures as resources, built-in shader inputs (aPosition, uProjectionMatrix); custom batchers, pipes, render bundles, 3D/array/storage textures. |
| performance | FPS, draw calls, memory leaks, first-frame hitches: teardown (destroy, Assets.unload), GCSystem, PrepareSystem, render groups, cacheAsTexture, batching order, culling (cullable), pooling, filter and mask cost. |
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

