mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-25 22:00:58 +02:00
@@ -1,52 +0,0 @@
|
||||
---
|
||||
title: images.Overlay
|
||||
description: Returns an image filter that overlays the source image at the given coordinates, relative to the upper left corner.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
aliases: []
|
||||
related:
|
||||
- functions/images/Filter
|
||||
- methods/resource/Filter
|
||||
returnType: images.filter
|
||||
signatures: [images.Overlay RESOURCE X Y]
|
||||
toc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
Capture the overlay image as a resource:
|
||||
|
||||
```go-html-template
|
||||
{{ $overlay := "" }}
|
||||
{{ $path := "images/logo.png" }}
|
||||
{{ with resources.Get $path }}
|
||||
{{ $overlay = . }}
|
||||
{{ else }}
|
||||
{{ errorf "Unable to get resource %q" $path }}
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
The overlay image can be a [global resource], a [page resource], or a [remote resource].
|
||||
|
||||
[global resource]: /getting-started/glossary/#global-resource
|
||||
[page resource]: /getting-started/glossary/#page-resource
|
||||
[remote resource]: /getting-started/glossary/#remote-resource
|
||||
|
||||
Create the filter:
|
||||
|
||||
```go-html-template
|
||||
{{ $filter := images.Overlay $overlay 20 20 }}
|
||||
```
|
||||
|
||||
{{% include "functions/images/_common/apply-image-filter.md" %}}
|
||||
|
||||
## Example
|
||||
|
||||
{{< img
|
||||
src="images/examples/zion-national-park.jpg"
|
||||
alt="Zion National Park"
|
||||
filter="Overlay"
|
||||
filterArgs="images/logos/logo-64x64.png,20,20"
|
||||
example=true
|
||||
>}}
|
Reference in New Issue
Block a user