pbj

tiny, stupid bitmap image format

npm install pbj
4 downloads in the last week
8 downloads in the last month

PBJ

PBJ is a really tiny, stupid image format for (monochrome) bitmaps. It's comparable to the PBM file format but it's even more trivial. The format goes like this:

  1. The width of the image as an unsigned, little-endian 16-bit integer.
  2. The height of the image as an unsigned, little-endian 16-bit integer.
  3. The bits of the image, ordered from left to right and top to bottom, packed eight to a byte. If the number of bits in an image is not an even multiple of eight, the extraneous bits in the last byte of the image are ignored.

It's not a very space-efficient format, but that's why God invented GZIP. If you pass this library a file ending in ".pbj.gz" or ".pbjz", it will decompress it for you.

"PBJ" stands for "Peanut Butter and Jelly." The "J" also stands for "Jay" which is itself a diminuitive for "Jason."

npm loves you