mirror of
https://github.com/lovell/sharp.git
synced 2025-07-09 10:30:15 +02:00
Docs refresh
This commit is contained in:
parent
638d540371
commit
161d127bf3
@ -159,14 +159,28 @@ Returns **Sharp**
|
|||||||
## blur
|
## blur
|
||||||
|
|
||||||
Blur the image.
|
Blur the image.
|
||||||
When used without parameters, performs a fast, mild blur of the output image.
|
|
||||||
|
When used without parameters, performs a fast 3x3 box blur (equivalent to a box linear filter).
|
||||||
|
|
||||||
When a `sigma` is provided, performs a slower, more accurate Gaussian blur.
|
When a `sigma` is provided, performs a slower, more accurate Gaussian blur.
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
* `sigma` **[number][1]?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
|
* `sigma` **[number][1]?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
|
||||||
|
|
||||||
<!---->
|
### Examples
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const boxBlurred = await sharp(input)
|
||||||
|
.blur()
|
||||||
|
.toBuffer();
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const gaussianBlurred = await sharp(input)
|
||||||
|
.blur(5)
|
||||||
|
.toBuffer();
|
||||||
|
```
|
||||||
|
|
||||||
* Throws **[Error][5]** Invalid parameters
|
* Throws **[Error][5]** Invalid parameters
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -20,14 +20,19 @@ module.exports = [
|
|||||||
'callback',
|
'callback',
|
||||||
'can',
|
'can',
|
||||||
'containing',
|
'containing',
|
||||||
|
'contains',
|
||||||
|
'current',
|
||||||
|
'date',
|
||||||
'default',
|
'default',
|
||||||
'does',
|
'does',
|
||||||
'each',
|
'each',
|
||||||
'either',
|
'either',
|
||||||
'ensure',
|
'ensure',
|
||||||
|
'entirely',
|
||||||
'etc',
|
'etc',
|
||||||
'every',
|
'every',
|
||||||
'except',
|
'except',
|
||||||
|
'following',
|
||||||
'for',
|
'for',
|
||||||
'from',
|
'from',
|
||||||
'get',
|
'get',
|
||||||
@ -37,10 +42,13 @@ module.exports = [
|
|||||||
'have',
|
'have',
|
||||||
'how',
|
'how',
|
||||||
'image',
|
'image',
|
||||||
|
'implies',
|
||||||
'involve',
|
'involve',
|
||||||
'its',
|
'its',
|
||||||
|
'last',
|
||||||
'least',
|
'least',
|
||||||
'lots',
|
'lots',
|
||||||
|
'make',
|
||||||
'may',
|
'may',
|
||||||
'more',
|
'more',
|
||||||
'most',
|
'most',
|
||||||
@ -56,6 +64,7 @@ module.exports = [
|
|||||||
'over',
|
'over',
|
||||||
'perform',
|
'perform',
|
||||||
'performs',
|
'performs',
|
||||||
|
'produce',
|
||||||
'provide',
|
'provide',
|
||||||
'provided',
|
'provided',
|
||||||
'ready',
|
'ready',
|
||||||
@ -67,12 +76,15 @@ module.exports = [
|
|||||||
'sets',
|
'sets',
|
||||||
'should',
|
'should',
|
||||||
'since',
|
'since',
|
||||||
|
'site',
|
||||||
|
'specified',
|
||||||
'spelling',
|
'spelling',
|
||||||
'such',
|
'such',
|
||||||
'support',
|
'support',
|
||||||
'supported',
|
'supported',
|
||||||
'sure',
|
'sure',
|
||||||
'take',
|
'take',
|
||||||
|
'task',
|
||||||
'than',
|
'than',
|
||||||
'that',
|
'that',
|
||||||
'the',
|
'the',
|
||||||
@ -84,12 +96,15 @@ module.exports = [
|
|||||||
'this',
|
'this',
|
||||||
'under',
|
'under',
|
||||||
'unless',
|
'unless',
|
||||||
|
'unmaintained',
|
||||||
|
'unsuitable',
|
||||||
'until',
|
'until',
|
||||||
'use',
|
'use',
|
||||||
'used',
|
'used',
|
||||||
'using',
|
'using',
|
||||||
'value',
|
'value',
|
||||||
'values',
|
'values',
|
||||||
|
'were',
|
||||||
'when',
|
'when',
|
||||||
'which',
|
'which',
|
||||||
'while',
|
'while',
|
||||||
|
Loading…
x
Reference in New Issue
Block a user