Some godoc adjustments and image struct renames

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)
+}