docs(pixel-io-pfm): add format ref links

thi-ng · Jul 13, 2023 · 9ff802b · 9ff802b
1 parent 9f15bb6
commit 9ff802b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/packages/pixel-io-pfm/README.md b/packages/pixel-io-pfm/README.md
@@ -23,9 +23,10 @@ Portable FloatMap image format support for [@thi.ng/pixel](https://github.com/th
 
 Similar to the [NetPBM format
 support](https://github.com/thi-ng/umbrella/tree/develop/packages/pixel-io-netpbm),
-the Portable FloatMap image format is extremely simple, uncompressed and mainly
-interesting for development purposes & interchange (e.g. for use with Intel's
-[Open Image Denoise CLI tools](https://github.com/OpenImageDenoise/oidn)).
+the [Portable FloatMap image format](https://pauldebevec.com/Research/HDR/PFM/)
+is extremely simple, uncompressed and mainly interesting for development
+purposes & interchange (e.g. for use with Intel's [Open Image Denoise CLI
+tools](https://github.com/OpenImageDenoise/oidn)).
 
 ## Status
 

diff --git a/packages/pixel-io-pfm/src/read.ts b/packages/pixel-io-pfm/src/read.ts
@@ -12,6 +12,9 @@ const __error = (msg?: string) => {
  * Parses given byte array as PFM image and returns it as thi.ng/pixel
  * [`FloatBuffer`](https://docs.thi.ng/umbrella/pixel/classes/FloatBuffer.html).
  *
+ * @remarks
+ * Format reference: https://pauldebevec.com/Research/HDR/PFM/
+ *
  * @param src
  */
 export const readPFM = (src: Uint8Array) => {

diff --git a/packages/pixel-io-pfm/tpl.readme.md b/packages/pixel-io-pfm/tpl.readme.md
@@ -8,9 +8,10 @@
 
 Similar to the [NetPBM format
 support](https://github.com/thi-ng/umbrella/tree/develop/packages/pixel-io-netpbm),
-the Portable FloatMap image format is extremely simple, uncompressed and mainly
-interesting for development purposes & interchange (e.g. for use with Intel's
-[Open Image Denoise CLI tools](https://github.com/OpenImageDenoise/oidn)).
+the [Portable FloatMap image format](https://pauldebevec.com/Research/HDR/PFM/)
+is extremely simple, uncompressed and mainly interesting for development
+purposes & interchange (e.g. for use with Intel's [Open Image Denoise CLI
+tools](https://github.com/OpenImageDenoise/oidn)).
 
 {{meta.status}}