From 39790c257bd8c44e136692f97902f7b43e466661 Mon Sep 17 00:00:00 2001
From: Hajime Hoshi <hajimehoshi@gmail.com>
Date: Mon, 8 Aug 2022 01:46:45 +0900
Subject: [PATCH] ebiten: update comments

---
 image.go | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/image.go b/image.go
index 16fc6a07a..fb5df68f7 100644
--- a/image.go
+++ b/image.go
@@ -28,7 +28,7 @@ import (
 
 // Image represents a rectangle set of pixels.
 // The pixel format is alpha-premultiplied RGBA.
-// Image implements image.Image and draw.Image.
+// Image implements the standard image.Image and draw.Image interfaces.
 type Image struct {
 	// addr holds self to check copying.
 	// See strings.Builder for similar examples.
@@ -765,6 +765,8 @@ func (i *Image) SubImage(r image.Rectangle) image.Image {
 }
 
 // Bounds returns the bounds of the image.
+//
+// Bounds implements the standard image.Image's Bounds.
 func (i *Image) Bounds() image.Rectangle {
 	if i.isDisposed() {
 		panic("ebiten: the image is already disposed")
@@ -773,6 +775,8 @@ func (i *Image) Bounds() image.Rectangle {
 }
 
 // ColorModel returns the color model of the image.
+//
+// ColorModel implements the standard image.Image's ColorModel.
 func (i *Image) ColorModel() color.Model {
 	return color.RGBAModel
 }
@@ -783,6 +787,8 @@ func (i *Image) ColorModel() color.Model {
 //
 // ReadPixels always sets a transparent color if the image is disposed.
 //
+// ReadPixels returns an error when an error occurs during reading pixels from GPU.
+//
 // len(pixels) must be 4*width*height. If the sizes don't match, ReadPixels returns an error.
 //
 // Note that an important logic should not rely on values returned by ReadPixels, since
@@ -810,6 +816,8 @@ func (i *Image) ReadPixels(pixels []byte) error {
 
 // At returns the color of the image at (x, y).
 //
+// At implements the standard image.Image's At.
+//
 // At loads pixels from GPU to system memory if necessary, which means that At can be slow.
 //
 // At always returns a transparent color if the image is disposed.
@@ -823,7 +831,7 @@ func (i *Image) At(x, y int) color.Color {
 	return color.RGBA{r, g, b, a}
 }
 
-// RGBA64At implements image.RGBA64Image's RGBA64At.
+// RGBA64At implements the standard image.RGBA64Image's RGBA64At.
 //
 // RGBA64At loads pixels from GPU to system memory if necessary, which means
 // that RGBA64At can be slow.
@@ -855,6 +863,8 @@ func (i *Image) at(x, y int) (r, g, b, a byte) {
 
 // Set sets the color at (x, y).
 //
+// Set implements the standard draw.Image's Set.
+//
 // Set loads pixels from GPU to system memory if necessary, which means that Set can be slow.
 //
 // In the current implementation, successive calls of Set invokes loading pixels at most once, so this is efficient.