Docs: add more examples (composite, greyscale, tint)

This commit is contained in:
Lovell Fuller 2022-03-12 20:33:15 +00:00
parent 72fd8abe2c
commit 42e45d842a
4 changed files with 54 additions and 1 deletions

View File

@ -9,7 +9,13 @@ An alpha channel may be present and will be unchanged by the operation.
* `rgb` **([string][1] | [Object][2])** parsed by the [color][3] module to extract chroma values. * `rgb` **([string][1] | [Object][2])** parsed by the [color][3] module to extract chroma values.
<!----> ### Examples
```javascript
const output = await sharp(input)
.tint({ r: 255, g: 240, b: 16 })
.toBuffer();
```
* Throws **[Error][4]** Invalid parameter * Throws **[Error][4]** Invalid parameter
@ -28,6 +34,12 @@ An alpha channel may be present, and will be unchanged by the operation.
* `greyscale` **[Boolean][5]** (optional, default `true`) * `greyscale` **[Boolean][5]** (optional, default `true`)
### Examples
```javascript
const output = await sharp(input).greyscale().toBuffer();
```
Returns **Sharp** Returns **Sharp**
## grayscale ## grayscale

View File

@ -46,6 +46,23 @@ and [https://www.cairographics.org/operators/][2]
### Examples ### Examples
```javascript
await sharp(background)
.composite([
{ input: layer1, gravity: 'northwest' },
{ input: layer2, gravity: 'southeast' },
])
.toFile('combined.png');
```
```javascript
const output = await sharp('input.gif', { animated: true })
.composite([
{ input: 'overlay.png', tile: true, blend: 'saturate' }
])
.toBuffer();
```
```javascript ```javascript
sharp('input.png') sharp('input.png')
.rotate(180) .rotate(180)

View File

@ -19,6 +19,11 @@ const colourspace = {
* Tint the image using the provided chroma while preserving the image luminance. * Tint the image using the provided chroma while preserving the image luminance.
* An alpha channel may be present and will be unchanged by the operation. * An alpha channel may be present and will be unchanged by the operation.
* *
* @example
* const output = await sharp(input)
* .tint({ r: 255, g: 240, b: 16 })
* .toBuffer();
*
* @param {string|Object} rgb - parsed by the [color](https://www.npmjs.org/package/color) module to extract chroma values. * @param {string|Object} rgb - parsed by the [color](https://www.npmjs.org/package/color) module to extract chroma values.
* @returns {Sharp} * @returns {Sharp}
* @throws {Error} Invalid parameter * @throws {Error} Invalid parameter
@ -37,6 +42,10 @@ function tint (rgb) {
* This may be overridden by other sharp operations such as `toColourspace('b-w')`, * This may be overridden by other sharp operations such as `toColourspace('b-w')`,
* which will produce an output image containing one color channel. * which will produce an output image containing one color channel.
* An alpha channel may be present, and will be unchanged by the operation. * An alpha channel may be present, and will be unchanged by the operation.
*
* @example
* const output = await sharp(input).greyscale().toBuffer();
*
* @param {Boolean} [greyscale=true] * @param {Boolean} [greyscale=true]
* @returns {Sharp} * @returns {Sharp}
*/ */

View File

@ -56,6 +56,21 @@ const blend = {
* @since 0.22.0 * @since 0.22.0
* *
* @example * @example
* await sharp(background)
* .composite([
* { input: layer1, gravity: 'northwest' },
* { input: layer2, gravity: 'southeast' },
* ])
* .toFile('combined.png');
*
* @example
* const output = await sharp('input.gif', { animated: true })
* .composite([
* { input: 'overlay.png', tile: true, blend: 'saturate' }
* ])
* .toBuffer();
*
* @example
* sharp('input.png') * sharp('input.png')
* .rotate(180) * .rotate(180)
* .resize(300) * .resize(300)