sharp/docs/api-colour.md

2.4 KiB

tint

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.

Parameters

  • Throws Error Invalid parameter

Returns Sharp

greyscale

Convert to 8-bit greyscale; 256 shades of grey. This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use gamma() with greyscale() for the best results. By default the output image will be web-friendly sRGB and contain three (identical) color channels. This may be overridden by other sharp operations such as toColourspace('b-w'), which will produce an output image containing one color channel. An alpha channel may be present, and will be unchanged by the operation.

Parameters

  • greyscale Boolean (optional, default true)

Returns Sharp

grayscale

Alternative spelling of greyscale.

Parameters

  • grayscale Boolean (optional, default true)

Returns Sharp

toColourspace

Set the output colourspace. By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.

Parameters

  • colourspace string? output colourspace e.g. srgb, rgb, cmyk, lab, b-w ...

Examples

// Output 16 bits per pixel RGB
await sharp(input)
 .toColourspace('rgb16')
 .toFile('16-bpp.png')
  • Throws Error Invalid parameters

Returns Sharp

toColorspace

Alternative spelling of toColourspace.

Parameters

  • colorspace string? output colorspace.
  • Throws Error Invalid parameters

Returns Sharp