Some godoc adjustments and image struct renames

resources/images/exif/exif.go

@@ -32,10 +32,18 @@ import (
 
 const exifTimeLayout = "2006:01:02 15:04:05"
 
-type Exif struct {
-	Lat  float64
+// ExifInfo holds the decoded Exif data for an Image.
+type ExifInfo struct {
+	// GPS latitude in degrees.
+	Lat float64
+
+	// GPS longitude in degrees.
 	Long float64
+
+	// Image creation date/time.
 	Date time.Time
+
+	// A collection of the available Exif tags for this Image.
 	Tags Tags
 }
 
@@ -106,7 +114,7 @@ func NewDecoder(options ...func(*Decoder) error) (*Decoder, error) {
 	return d, nil
 }
 
-func (d *Decoder) Decode(r io.Reader) (ex *Exif, err error) {
+func (d *Decoder) Decode(r io.Reader) (ex *ExifInfo, err error) {
 	defer func() {
 		if r := recover(); r != nil {
 			err = fmt.Errorf("Exif failed: %v", r)
@@ -139,7 +147,7 @@ func (d *Decoder) Decode(r io.Reader) (ex *Exif, err error) {
 		return
 	}
 
-	ex = &Exif{Lat: lat, Long: long, Date: tm, Tags: walker.vals}
+	ex = &ExifInfo{Lat: lat, Long: long, Date: tm, Tags: walker.vals}
 
 	return
 }

resources/images/exif/exif_test.go

@@ -56,7 +56,7 @@ func TestExif(t *testing.T) {
 	// Verify that it survives a round-trip to JSON and back.
 	data, err := json.Marshal(x)
 	c.Assert(err, qt.IsNil)
-	x2 := &Exif{}
+	x2 := &ExifInfo{}
 	err = json.Unmarshal(data, x2)
 
 	c.Assert(x2, eq, x)

resources/images/image.go

@@ -192,7 +192,7 @@ type ImageProcessor struct {
 	exifDecoder *exif.Decoder
 }
 
-func (p *ImageProcessor) DecodeExif(r io.Reader) (*exif.Exif, error) {
+func (p *ImageProcessor) DecodeExif(r io.Reader) (*exif.ExifInfo, error) {
 	return p.exifDecoder.Decode(r)
 }
 

resources/images/image_resource.go

@@ -0,0 +1,53 @@
+// Copyright 2022 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
+
+	// 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(spec string) (ImageResource, error)
+	Fit(spec string) (ImageResource, error)
+	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
+
+	// Internal
+	DecodeImage() (image.Image, error)
+}