images.Brightness

Returns an image filter that changes the brightness of an image.

Syntax

images.Brightness PERCENTAGE

Returns

images.filter

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:

{{ $filter := images.Brightness 12 }}

Apply the filter using the images.Filter function:

{{ with resources.Get "images/original.jpg" }}
  {{ with . | images.Filter $filter }}
    <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ end }}
{{ end }}

You can also apply the filter using the Filter method on a Resource object:

{{ with resources.Get "images/original.jpg" }}
  {{ with .Filter $filter }}
    <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ end }}
{{ end }}

Example

Original

Processed

Last updated: December 4, 2023 : Squashed 'docs/' changes from 4d936aee6..4dd2d6415 (35dec7c96)

Improve this page