Skip to content

dy/image-encode

Repository files navigation

image-encode unstable Build Status

Encode image data to a container: PNG, GIF, BMP, JPEG or TIFF. Uses set of encoders in node and Canvas2D in browser.

Usage

npm install image-encode

let encode = require('image-encode')

// create a file with chess pattern
fs.writeFileSync(
	'out.png',
	Buffer.from(encode([0,0,0,255, 255,255,255,255, 255,255,255,255, 0,0,0,255], [2, 2], 'png'))
)

API

let data = encode(pixels, shape?, format|options?)

Takes input pixels Array/TypedArray/ArrayBuffer/Buffer/ImageData, returns an ArrayBuffer with encoded data in target format, one of png, gif, tif, bmp, jpg.

options can provide:

  • format or type, if not specified as a separate argument.
  • shape or width/height, if not defined by pixels or as a separate argument.
  • quality for JPG encoder.
  • colors for palette size in GIF encoder.
  • any other meta fields for encoders.

See also

Footer

© 2018 Dmitry Yv. MIT License.

About

Encode pixels data to PNG, GIF, BMP, TIF or JPG

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published