mirror of
https://github.com/odin-lang/Odin.git
synced 2026-01-05 20:48:04 +00:00
a0cff82320
`c/frontend/tokenizer`:
add proper "Example:" header to demo example code,
removed empty lines.
`container/bit_array`:
moved comment before package;
aligned narrative lines to left margin;
converted case lines into bulleted lines ("- ");
converted individual examples to single-tab-indented preformatted text.
`dynlib`:
removed "//+build ignore" line;
added newline at EOF.
`image/netpmb`:
converted indented lines of "Reading", "Wrting" and "Some syntax..." into bulleted lists;
"Formats" indented lines kept as they are as the preformatted text seems relevant to keep the alignments;
doubly indented lines kept as single-indented to keep them different (as the format does not allow for two-level bulleted lists);
removed empy lines.
`os/os2`: WIP, not modified
`sys/info`:
removed "//+build ignore" line;
converted tab-indented initial description into regular left-margin comment;
moved uncommented sample code within the doc comment as an "Example:";
moved simple- and double-tabbed separate comments with sample Windows and macOS outputs within the doc comment as bulleted headlines with preformatted output listings;
removed now empty comments and blank lines after the package line.
`text/i18n`:
removed "//+build ignore" line;
moved the pacakge line at the end;
de-indented the tab-indented introductory narrative;
moved sample code comments into the doc comment as tab-indented code with a proper "Example:" heading;
removed "```" MD attempts at code formatting.
`text/table`:
unindented the comment lines of a descriptive kind;
headlines of major subdivisions are marked as bold;
kept code samples as tab-indented preformatted text (as there are several of them, the standard "Example:" and "Output:" headings cannot be used) removing the "```" MD attempts at code formatting;
removed in-between blank lines.
37 lines
1.9 KiB
Odin
37 lines
1.9 KiB
Odin
/*
|
|
Formats:
|
|
|
|
PBM (P1, P4): Portable Bit Map, stores black and white images (1 channel)
|
|
PGM (P2, P5): Portable Gray Map, stores greyscale images (1 channel, 1 or 2 bytes per value)
|
|
PPM (P3, P6): Portable Pixel Map, stores colour images (3 channel, 1 or 2 bytes per value)
|
|
PAM (P7 ): Portable Arbitrary Map, stores arbitrary channel images (1 or 2 bytes per value)
|
|
PFM (Pf, PF): Portable Float Map, stores floating-point images (Pf: 1 channel, PF: 3 channel)
|
|
|
|
Reading:
|
|
|
|
- All formats fill out header fields `format`, `width`, `height`, `channels`, `depth`.
|
|
- Specific formats use more fields:
|
|
PGM, PPM, and PAM set `maxval` (maximum of 65535)
|
|
PAM sets `tupltype` if there is one, and can set `channels` to any value (not just 1 or 3)
|
|
PFM sets `scale` (float equivalent of `maxval`) and `little_endian` (endianness of stored floats)
|
|
- Currently doesn't support reading multiple images from one binary-format file.
|
|
|
|
Writing:
|
|
|
|
- You can use your own `Netpbm_Info` struct to control how images are written.
|
|
- All formats require the header field `format` to be specified.
|
|
- Additional header fields are required for specific formats:
|
|
PGM, PPM, and PAM require `maxval` (maximum of 65535)
|
|
PAM also uses `tupltype`, though it may be left as default (empty or nil string)
|
|
PFM requires `scale`, and optionally `little_endian`
|
|
|
|
Some syntax differences from the specifications:
|
|
|
|
- `channels` stores the number of values per pixel, what the PAM specification calls `depth`
|
|
- `depth` instead is the number of bits for a single value (32 for PFM, 16 or 8 otherwise)
|
|
- `scale` and `little_endian` are separated, so the `header` will always store a positive `scale`
|
|
- `little_endian` will only be true for a negative `scale` PFM, every other format will be false
|
|
- `little_endian` only describes the netpbm data being read/written, the image buffer will be native
|
|
*/
|
|
package netpbm
|