Docs: info about how animated images are loaded

lovell · Nov 27, 2023 · 9c877d9 · 9c877d9
1 parent 7ad86fe
commit 9c877d9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/api-constructor.md b/docs/api-constructor.md
@@ -17,6 +17,10 @@ Non-critical problems encountered during processing are emitted as `warning` eve
 
 Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
 
+When loading more than one page/frame of an animated image,
+these are combined as a vertically-stacked "toilet roll" image
+where the overall height is the `pageHeight` multiplied by the number of `pages`.
+
 **Throws**:
 
 - <code>Error</code> Invalid parameters

diff --git a/lib/constructor.js b/lib/constructor.js
@@ -22,6 +22,10 @@ const debuglog = util.debuglog('sharp');
  *
  * Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
  *
+ * When loading more than one page/frame of an animated image,
+ * these are combined as a vertically-stacked "toilet roll" image
+ * where the overall height is the `pageHeight` multiplied by the number of `pages`.
+ *
  * @constructs Sharp
  *
  * @emits Sharp#info