Skip to content

Commit fcdb087

Browse files
committed
Add blur_areas docs
1 parent dd81c7e commit fcdb087

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/usage/processing.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,24 @@ ush:%mode:%weight:%divider
544544

545545
Allows redefining unsharp masking options. All arguments have the same meaning as [Unsharp masking](../configuration/options.mdx#unsharp-masking) configs. All arguments are optional and can be omitted.
546546

547+
### Blur areas ((pro)) {#blur-areas}
548+
549+
```imgproxy_url_option
550+
blur_areas:%sigma:%left1:%top1:%width1:%height1:...:%leftN:%topN:%widthN:%heightN
551+
ba:%sigma:%left1:%top1:%width1:%height1:...:%leftN:%topN:%widthN:%heightN
552+
```
553+
554+
When `sigma` is greater than `0`, imgproxy will apply a Gaussian blur filter to the defined areas of the resulting image.
555+
556+
* `sigma` - defines the size of the mask imgproxy will use.
557+
* `left`, `top`, `width`, `height` - define the area to be blurred. The values are floating-point numbers between `0` and `1` that define the area position and size relative to the source image dimensions. For example, `left` of `0.5` means the left edge of the area is at the image's center, and `width` of `0.25` means the area's width is a quarter of the image width.
558+
559+
:::info
560+
The areas' coordinates should be defined with respect to the source image EXIF orientation, as imgproxy doesn't rotate/flip them according to EXIF orientation. However, imgproxy rotates/flips the areas according to the [rotate](#rotate) and [flip](#flip) options.
561+
:::
562+
563+
Default: disabled
564+
547565
### Blur detections ((pro)) {#blur-detections}
548566

549567
```imgproxy_url_option

0 commit comments

Comments
 (0)