Tiled Image Tools

This is a promise-based library for encoding and decoding tiled images.

Options

|Option |Description| |--------------|-----------| |Data |RGBA encoded data buffer| |Width |The image width, if encoding, you can specify a smaller width to crop to| |Height |The image height, if encoding, you can specify a smaller height to crop to| |cropWidth |Used when decodingThe width to crop the output image to. |cropHeight|Used when decoding The height to crop the output image to. |type |The encoding type, allowed values are:a8rgb888rgb565bgr888bgr565|

Encoding

This example will read a PNG using the pngjs library and encode the image data.

var fs = require('fs')
var tileTools = require('tiled-image-tools')
var PNG = require('pngjs').PNG

fs.createReadStream('./MyImage.png')
  .pipe(new PNG({}))
  .on('parsed', function () {
    tileUtils.convertToTiled({
      'data': this.data,     // Raw RGBA data from pngjs
      'width': this.width,   // The image width, you can also specify a smaller size if you want to crop
      'height': this.height, // The image height, you can also specify a smaller size if you want to crop
      'type': 'rgb565'       // We will encode to rgb565
    }).then(function (encoded) {
      /*
        encoded will be an object with the following keys:
        
        data: A buffer with the encoded data
        width: The encoded image width
        height: The encoded image height
        type: The encoding type
      */
    }
  })

Decoding

This example will take an RGB565 encoded image and decode it to RGBA

var fs = require('fs')
var tileTools = require('tiled-image-tools')

fs.readFile('./RGB565Image.bin', function (data) {
  tileUtils.convertFromTiled({
    'data': data,    // The raw RGB565 data
    'width': 48,     // This must be provided when decoding
    'height': 48,    // This must be provided when decoding
    'type': 'rgb565' // We are decoding from rgb565
  }).then(function (decoded) {
    /*
      decoded will be an object with the following keys.
      
      data: A buffer with the decoded RGBA values
      width: The image width
      height: The image height
      type: the encoding type used to decode the image.
    */
  })
}

Credits

Based on code by Marc Robledo http://usuaris.tinet.cat/mark/smdh_creator/