aboutsummaryrefslogtreecommitdiff
path: root/core/image
diff options
context:
space:
mode:
authorMaurizio M. Gavioli <mmg@vistamaresoft.com>2024-04-14 17:18:08 +0200
committerMaurizio M. Gavioli <mmg@vistamaresoft.com>2024-04-14 17:18:08 +0200
commita0cff82320840e4be6d40cee8a2432645773a53e (patch)
treedbb5b972d03b14f636ef0aa120da8075ee906fc0 /core/image
parent21969fec612b78d34f14b60ad761a3c37860b36b (diff)
Fix the format of some `doc.odin` files of the `core` library which did not made into the documentation.
`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.
Diffstat (limited to 'core/image')
-rw-r--r--core/image/netpbm/doc.odin39
1 files changed, 21 insertions, 18 deletions
diff --git a/core/image/netpbm/doc.odin b/core/image/netpbm/doc.odin
index 1b5b46856..7106e023e 100644
--- a/core/image/netpbm/doc.odin
+++ b/core/image/netpbm/doc.odin
@@ -1,5 +1,6 @@
/*
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)
@@ -7,27 +8,29 @@ Formats:
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
+
+- 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`
+
+- 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
-*/
+- `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