Packs pixmaps into one or more pages to generate an atlas of pixmap instances. Provides means to directly convert the pixmap atlas to a TextureAtlas. The packer supports padding and border pixel duplication, specified during construction. The packer supports incremental inserts and updates of TextureAtlases generated with this class. How bin packing is performed can be customized via PackStrategy.

All methods can be called from any thread unless otherwise noted.

One-off usage:

// 512x512 pixel pages, RGB565 format, 2 pixels of padding, border duplication
PixmapPacker packer = new PixmapPacker(512, 512, Format.RGB565, 2, true);
packer.pack("First Pixmap", pixmap1);
packer.pack("Second Pixmap", pixmap2);
TextureAtlas atlas = packer.generateTextureAtlas(TextureFilter.Nearest, TextureFilter.Nearest, false);
packer.dispose();
// ...
atlas.dispose();

With this usage pattern, disposing the packer will not dispose any pixmaps used by the texture atlas. The texture atlas must also be disposed when no longer needed. Incremental texture atlas usage:

// 512x512 pixel pages, RGB565 format, 2 pixels of padding, no border duplication
PixmapPacker packer = new PixmapPacker(512, 512, Format.RGB565, 2, false);
TextureAtlas atlas = new TextureAtlas();

// potentially on a separate thread, e.g. downloading thumbnails
packer.pack("thumbnail", thumbnail);

// on the rendering thread, every frame
packer.updateTextureAtlas(atlas, TextureFilter.Linear, TextureFilter.Linear, false);

// once the atlas is no longer needed, make sure you get the final additions. This might
// be more elaborate depending on your threading model.
packer.updateTextureAtlas(atlas, TextureFilter.Linear, TextureFilter.Linear, false);
// ...
atlas.dispose();

Pixmap-only usage:

PixmapPacker packer = new PixmapPacker(512, 512, Format.RGB565, 2, true);
packer.pack("First Pixmap", pixmap1);
packer.pack("Second Pixmap", pixmap2);

// do something interesting with the resulting pages
for (Page page : packer.getPages()) {
	// ...
}

packer.dispose();