summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/images/Hue.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/images/Hue.md')
-rw-r--r--docs/content/en/functions/images/Hue.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/content/en/functions/images/Hue.md b/docs/content/en/functions/images/Hue.md
new file mode 100644
index 000000000..f334eebd8
--- /dev/null
+++ b/docs/content/en/functions/images/Hue.md
@@ -0,0 +1,33 @@
+---
+title: images.Hue
+description: Returns an image filter that rotates the hue of an image.
+categories: []
+keywords: []
+params:
+ functions_and_methods:
+ aliases: []
+ returnType: images.filter
+ signatures: [images.Hue SHIFT]
+---
+
+The hue angle shift is typically in the range [-180, 180] where 0 has no effect.
+
+## Usage
+
+Create the filter:
+
+```go-html-template
+{{ $filter := images.Hue -15 }}
+```
+
+{{% include "/_common/functions/images/apply-image-filter.md" %}}
+
+## Example
+
+{{< img
+ src="images/examples/zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="Hue"
+ filterArgs="-15"
+ example=true
+>}}