summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/images/GaussianBlur.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/images/GaussianBlur.md')
-rw-r--r--docs/content/en/functions/images/GaussianBlur.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/content/en/functions/images/GaussianBlur.md b/docs/content/en/functions/images/GaussianBlur.md
new file mode 100644
index 000000000..c5eb136e2
--- /dev/null
+++ b/docs/content/en/functions/images/GaussianBlur.md
@@ -0,0 +1,33 @@
+---
+title: images.GaussianBlur
+description: Returns an image filter that applies a gaussian blur to an image.
+categories: []
+keywords: []
+params:
+ functions_and_methods:
+ aliases: []
+ returnType: images.filter
+ signatures: [images.GaussianBlur SIGMA]
+---
+
+The sigma value must be positive, and indicates how much the image will be blurred. The blur-affected radius is approximately 3 times the sigma value.
+
+## Usage
+
+Create the filter:
+
+```go-html-template
+{{ $filter := images.GaussianBlur 5 }}
+```
+
+{{% include "/_common/functions/images/apply-image-filter.md" %}}
+
+## Example
+
+{{< img
+ src="images/examples/zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="GaussianBlur"
+ filterArgs="5"
+ example=true
+>}}