1681-engine / index / AtlasBuilder

Class: AtlasBuilder

Defined in: src/core/atlas.ts:19

Packs many small procedurally painted canvases into as few textures as the GPU allows, so Pixi can batch every sprite of the world into very few draw calls. One page on every desktop (up to 8192 square); a device whose GPU takes less gets pages of limit (atlasPageLimit, planAtlas). Every frame is registered under the one key whichever page holds it — the pages after the first are textures of their own (key~1, key~2…) whose frames the first page's texture adopts — so the world keeps asking for atlas and a frame name, and never knows. Frame names: name for single images, name#i for sheet frames.

Constructors

Constructor

new AtlasBuilder(): AtlasBuilder;

Returns

AtlasBuilder

Methods

add()

add(name, canvas): void;

Defined in: src/core/atlas.ts:22

Parameters

Parameter	Type
name	string
canvas	HTMLCanvasElement

Returns

void

---

addSheet()

addSheet(
   name, 
   canvas, 
   frameWidth, 
   frameHeight
): void;

Defined in: src/core/atlas.ts:26

Parameters

Parameter	Type
name	string
canvas	HTMLCanvasElement
frameWidth	number
frameHeight	number

Returns

void

---

build()

build(
   textures, 
   key, 
   limit?
): void;

Defined in: src/core/atlas.ts:30

Parameters

Parameter	Type	Default value
textures	TextureRegistry	undefined
key	string	undefined
limit	number	ATLAS_PAGE_FULL

Returns

void