mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
e197c7b29d
To sort an image's colors from darkest to lightest, you can then do:
```handlebars
{{ {{ $colorsByLuminance := sort $image.Colors "Luminance" }}
```
This uses the formula defined here: https://www.w3.org/TR/WCAG21/#dfn-relative-luminance
Fixes #10450
70 lines
2.3 KiB
Go
70 lines
2.3 KiB
Go
// Copyright 2024 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package images
|
|
|
|
import (
|
|
"image"
|
|
|
|
"github.com/gohugoio/hugo/resources/images/exif"
|
|
"github.com/gohugoio/hugo/resources/resource"
|
|
)
|
|
|
|
// ImageResource represents an image resource.
|
|
type ImageResource interface {
|
|
resource.Resource
|
|
ImageResourceOps
|
|
}
|
|
|
|
type ImageResourceOps interface {
|
|
// Height returns the height of the Image.
|
|
Height() int
|
|
|
|
// Width returns the width of the Image.
|
|
Width() int
|
|
|
|
// Process applies the given image processing options to the image.
|
|
Process(spec string) (ImageResource, error)
|
|
|
|
// Crop an image to match the given dimensions without resizing.
|
|
// You must provide both width and height.
|
|
// Use the anchor option to change the crop box anchor point.
|
|
// {{ $image := $image.Crop "600x400" }}
|
|
Crop(spec string) (ImageResource, error)
|
|
|
|
// Fill scales the image to the smallest possible size that will cover the specified dimensions in spec,
|
|
// crops the resized image to the specified dimensions using the given anchor point.
|
|
// The spec is space delimited, e.g. `200x300 TopLeft`.
|
|
Fill(spec string) (ImageResource, error)
|
|
|
|
// Fit scales down the image using the given spec.
|
|
Fit(spec string) (ImageResource, error)
|
|
|
|
// Resize resizes the image to the given spec. If one of width or height is 0, the image aspect
|
|
// ratio is preserved.
|
|
Resize(spec string) (ImageResource, error)
|
|
|
|
// Filter applies one or more filters to an Image.
|
|
// {{ $image := $image.Filter (images.GaussianBlur 6) (images.Pixelate 8) }}
|
|
Filter(filters ...any) (ImageResource, error)
|
|
|
|
// Exif returns an ExifInfo object containing Image metadata.
|
|
Exif() *exif.ExifInfo
|
|
|
|
// Colors returns a slice of the most dominant colors in an image
|
|
// using a simple histogram method.
|
|
Colors() ([]Color, error)
|
|
|
|
// For internal use.
|
|
DecodeImage() (image.Image, error)
|
|
}
|