status-im/nimPNG
2
0
Fork 0
mirror of https://github.com/status-im/nimPNG.git synced 2025-02-25 18:55:29 +00:00
Code Issues Projects Releases Wiki Activity

update readme.md

Browse Source
This commit is contained in:
andri lim 2017-11-04 16:52:17 +07:00
parent 0d81e2d6e7
commit 9e196c2376
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
readme.md
View File

@ -1,6 +1,8 @@
# nimPNG # nimPNG
Portable Network Graphics Encoder and Decoder written in Nim store lossless image with good compression Portable Network Graphics Encoder and Decoder written in Nim store lossless image with good compression
[![Build Status][badge-nimpng-travisci]][nimpng-travisci]
all PNG standard color mode are supported: all PNG standard color mode are supported:
- LCT_GREY = 0, # greyscale: 1,2,4,8,16 bit - LCT_GREY = 0, # greyscale: 1,2,4,8,16 bit
@ -77,7 +79,7 @@ to create PNG:
special notes: special notes:
* Use **loadPNG** or **savePNG** if you need specific input/output format by supplying supported **colorType** and **bitDepth** information. * Use **loadPNG** or **savePNG** if you need specific input/output format by supplying supported **colorType** and **bitDepth** information.
* Use **encodePNG** or **decodePNG** to do *in-memory* encoding/decoding by supplying desired colorType and bitDepth information * Use **encodePNG** or **decodePNG** to do *in-memory* encoding/decoding by supplying desired colorType and bitDepth information
pixels are stored as raw bytes using Nim's string as container: pixels are stored as raw bytes using Nim's string as container:
@ -88,3 +90,8 @@ pixels are stored as raw bytes using Nim's string as container:
| r1,g1,b1,r2,g2,b2,...,rn,gn,bn | RGB 8 bit | | r1,g1,b1,r2,g2,b2,...,rn,gn,bn | RGB 8 bit |
| grey1,grey2,grey3, ..., greyn | GREY 8 bit | | grey1,grey2,grey3, ..., greyn | GREY 8 bit |
| grey1,a1,grey2,a2,...,greyn,an | GREY ALPHA 8 bit | | grey1,a1,grey2,a2,...,greyn,an | GREY ALPHA 8 bit |
[nimpng-travisci]: https://travis-ci.org/jangko/nimPNG
[badge-nimpng-travisci]: https://travis-ci.org/jangko/nimPNG.svg?branch=master