Batch pack multiple bins into the sprite.

var bins = [
    { id: 1, w: 12, h: 12 },
    { id: 2, w: 12, h: 16 },
    { id: 3, w: 12, h: 24 }
];
var results = sprite.pack(bins, { inPlace: false });

Pack a single bin into the sprite.

Each bin will have a unique identitifer. If no identifier is supplied in the id parameter, one will be created. Note: The supplied id is used as an object index, so numeric values are fastest!

Bins are automatically refcounted (i.e. a newly packed Bin will have a refcount of 1). When a bin is no longer needed, use the ShelfPack.unref function to mark it as unused. When a Bin's refcount decrements to 0, the Bin will be marked as free and its space may be reused by the packing code.

var results = sprite.packOne(12, 16, 'a');

Shrink the width/height of the sprite to the bare minimum. Since shelf-pack doubles first width, then height when running out of shelf space this can result in fairly large unused space both in width and height if that happens towards the end of bin packing.

Return a packed bin given its id, or undefined if the id is not found

var b = sprite.getBin('a');

Increment the ref count of a bin and update statistics.

var bin = sprite.getBin('a');
sprite.ref(bin);

Decrement the ref count of a bin and update statistics. The bin will be automatically marked as free space once the refcount reaches 0.

var bin = sprite.getBin('a');
sprite.unref(bin);

Clear the sprite. Resets everything and resets statistics.

sprite.clear();

Resize the sprite.

sprite.resize(256, 256);