@fitbit/image-codec-txi

TXI image format encoder library

Stats

StarsIssuesVersionUpdatedCreatedSize
@fitbit/image-codec-txi
341.1.510 months ago3 years agoMinified + gzip package size for @fitbit/image-codec-txi in KB

Readme

@fitbit/image-codec-txi

Greenkeeper badge

Coverage Status

TXI is an image format used on some Fitbit devices. This package is used to convert a raw bitmap raster to a TXI formatted image that is supported on the device.

API

encode(image: ImageData, options: TXIEncoderOptions):

Interface: ImageData

{
  width: number;
  height: number;
  data: Uint8ClampedArray;
}

Interface: TXIEncoderOptions

{
  rle?: boolean | 'auto';
  outputFormat?: TXIOutputFormat;
}

Enum: TXIOutputFormat

{
  RGB565 = 'RGB565',
  RGBA6666 = 'RGBA6666',
  RGBA8888 = 'RGBA8888',
  A8 = 'A8',
}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.