mirror of https://github.com/gohugoio/hugo
34 lines
756 B
Markdown
34 lines
756 B
Markdown
---
|
|
title: images.Brightness
|
|
description: Returns an image filter that changes the brightness of an image.
|
|
categories: []
|
|
keywords: []
|
|
params:
|
|
functions_and_methods:
|
|
aliases: []
|
|
returnType: images.filter
|
|
signatures: [images.Brightness PERCENTAGE]
|
|
---
|
|
|
|
The percentage must be in the range [-100, 100] where 0 has no effect. A value of `-100` produces a solid black image, and a value of `100` produces a solid white image.
|
|
|
|
## Usage
|
|
|
|
Create the image filter:
|
|
|
|
```go-html-template
|
|
{{ $filter := images.Brightness 12 }}
|
|
```
|
|
|
|
{{% include "/_common/functions/images/apply-image-filter.md" %}}
|
|
|
|
## Example
|
|
|
|
{{< img
|
|
src="images/examples/zion-national-park.jpg"
|
|
alt="Zion National Park"
|
|
filter="Brightness"
|
|
filterArgs="12"
|
|
example=true
|
|
>}}
|