jiro4989 / pnm

Library for PNM in pure Nim.

pnm

Table of Contents

• 1. Development
• 2. Install
• 3. Usage
  • 3.1. Reading PGM file
  • 3.2. Writing PGM file
  • 3.3. Other examples
• 4. Warning
• 5. Document

PNM (Portable Anymap) parser/generator library in pure Nim.

1. Development

nim -v

Nim Compiler Version 0.19.4 [Linux: amd64]
Compiled at 2019-02-01
Copyright (c) 2006-2018 by Andreas Rumpf

git hash: b6d96cafc8bcad1f3d32f2910b25cd11a93f7751
active boot switches: -d:release

nimble -v

nimble v0.9.0 compiled at 2018-10-27 18:10:03
git hash: couldn't determine git hash

2. Install

nimble install pnm

3. Usage

3.1. Reading PGM file

import pnm

block:
  # P2
  let p = readPGMFile("tests/out/p2.pgm")
  echo p

block:
  # P5
  let p = readPGMFile("tests/out/p5.pgm")
  echo p

3.2. Writing PGM file

import pnm

let col = 6
let row = 12
let data = @[
  0'u8, 0, 0, 0, 0, 0,
  0'u8, 0, 0, 0, 0, 0,
  0'u8, 0, 0, 0, 0, 0,
  0'u8, 0, 0, 0, 0, 0,
  1, 1, 1, 1, 1, 1,
  1, 1, 1, 1, 1, 1,
  1, 1, 1, 1, 1, 1,
  1, 1, 1, 1, 1, 1,
  2, 2, 2, 2, 2, 2,
  2, 2, 2, 2, 2, 2,
  2, 2, 2, 2, 2, 2,
  2, 2, 2, 2, 2, 2,
]

block:
  # P2
  let p = newPGM(pgmFileDescriptorP2, col, row, data)
  writePGMFile("tests/out/p2.pgm", p)

block:
  # P5
  let p = newPGM(pgmFileDescriptorP5, col, row, data)
  writePGMFile("tests/out/p5.pgm", p)

3.3. Other examples

See examples directory. Run example code.

Generating PBM.

cd write_pbm
nim c -d:release main.nim
./main

Generating PGM.

cd write_pgm
nim c -d:release main.nim
./main

Generating PPM.

cd write_ppm
nim c -d:release main.nim
./main

Controling generated PNM files.

cd read_file
nim c -d:release main.nim
./main

4. Warning

Available color byte of PGM and PPM is 1 byte (0~255).

5. Document

• https://jiro4989.github.io/pnm/pnm.html