Skip to content

Commit 9c877d9

Browse files
committedNov 27, 2023
Docs: info about how animated images are loaded
1 parent 7ad86fe commit 9c877d9

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed
 

‎docs/api-constructor.md

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Non-critical problems encountered during processing are emitted as `warning` eve
1717

1818
Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
1919

20+
When loading more than one page/frame of an animated image,
21+
these are combined as a vertically-stacked "toilet roll" image
22+
where the overall height is the `pageHeight` multiplied by the number of `pages`.
23+
2024
**Throws**:
2125

2226
- <code>Error</code> Invalid parameters

‎lib/constructor.js

+4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ const debuglog = util.debuglog('sharp');
2222
*
2323
* Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
2424
*
25+
* When loading more than one page/frame of an animated image,
26+
* these are combined as a vertically-stacked "toilet roll" image
27+
* where the overall height is the `pageHeight` multiplied by the number of `pages`.
28+
*
2529
* @constructs Sharp
2630
*
2731
* @emits Sharp#info

0 commit comments

Comments
 (0)
Please sign in to comment.