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

Docs: clarify use of integral pixel values for extract

Browse Source
This commit is contained in:
Lovell Fuller 2019-04-01 20:06:46 +01:00
parent fc178de309
commit 6032171f91
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api-resize.md
View File

@ -163,11 +163,11 @@ Extract a region of the image.
### Parameters ### Parameters
- `options` **[Object][9]** - `options` **[Object][9]** describes the region to extract using integral pixel values
- `options.left` **[Number][8]** zero-indexed offset from left edge - `options.left` **[Number][8]** zero-indexed offset from left edge
- `options.top` **[Number][8]** zero-indexed offset from top edge - `options.top` **[Number][8]** zero-indexed offset from top edge
- `options.width` **[Number][8]** dimension of extracted image - `options.width` **[Number][8]** width of region to extract
- `options.height` **[Number][8]** dimension of extracted image - `options.height` **[Number][8]** height of region to extract
### Examples ### Examples

6
lib/resize.js
View File

@ -334,11 +334,11 @@ function extend (extend) {
* // Extract a region, resize, then extract from the resized image * // Extract a region, resize, then extract from the resized image
* }); * });
* *
* @param {Object} options * @param {Object} options - describes the region to extract using integral pixel values
* @param {Number} options.left - zero-indexed offset from left edge * @param {Number} options.left - zero-indexed offset from left edge
* @param {Number} options.top - zero-indexed offset from top edge * @param {Number} options.top - zero-indexed offset from top edge
* @param {Number} options.width - dimension of extracted image * @param {Number} options.width - width of region to extract
* @param {Number} options.height - dimension of extracted image * @param {Number} options.height - height of region to extract
* @returns {Sharp} * @returns {Sharp}
* @throws {Error} Invalid parameters * @throws {Error} Invalid parameters
*/ */