Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 18:40:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: info about how animated images are loaded

Browse Source
This commit is contained in:
Lovell Fuller 2023-11-27 20:35:53 +00:00
parent 7ad86fed03
commit 9c877d93fa
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api-constructor.md
View File

@ -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. 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**: **Throws**:
- <code>Error</code> Invalid parameters - <code>Error</code> Invalid parameters

4
lib/constructor.js
View File

@ -22,6 +22,10 @@ const debuglog = util.debuglog('sharp');
* *
* Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class. * 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 * @constructs Sharp
* *
* @emits Sharp#info * @emits Sharp#info