Struct Pnm

pub struct Pnm;

Available on crate feature image only.

A collection of methods for encoding and decoding PNM bitmap formats.

• https://en.wikipedia.org/wiki/Netpbm

The PBM (Portable Bitmap), PGM (Portable Graymap), and PPM (Portable Pixmap) formats are part of the Netpbm format family. These formats are simple and straightforward for representing grayscale (PGM), black and white (PBM), and color (PPM) images in either ASCII or binary modes. Here’s a brief overview:

• PBM (Portable Bitmap Format): Used for black and white images. It supports both ASCII (P1) and binary (P4) representations.

• PGM (Portable Graymap Format): Used for grayscale images. It also supports ASCII (P2) and binary (P5) representations, with the gray value typically ranging from 0 (black) to 255 (white) for 8-bit images.

• PPM (Portable Pixmap Format): Used for color images. Similar to PGM, it supports ASCII (P3) and binary (P6) formats. Each pixel is represented by three values (red, green, and blue), each in the range of 0 to 255 for 8-bit images.

Implementations

impl Pnm

pub fn p1_encode_bytes( bitmap: &[u8], width: usize, height: usize, ) -> Result<String>

Available on crate feature alloc only.

Converts a bitmap of 1-bit bytes into PBM ASCII P1 representation.

Expects a slice of width * height bytes equal to 0 or 1.

Errors

Returns InvalidImageSize if the bitmap slice doesn’t contain exactly width * height elements, InvalidPixel if any pixel value is invalid and FmtError if the string writing fails.

pub fn p1_encode_bits( bitmap: &[u8], width: usize, height: usize, ) -> Result<String>

Available on crate feature alloc only.

Converts a bitmap of 1-bit bits into PBM ASCII P1 representation.

Each byte in bitmap represents 8 pixels, with the most significant bit (MSB) of each byte representing the leftmost pixel.

Errors

Returns InvalidImageSize if the bitmap slice doesn’t contain exactly the number of expected bytes width * height elements and FmtError if the string writing fails.