mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-11-10 04:57:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

ebiten: update comments

Browse Source
This commit is contained in:
Hajime Hoshi 2022-08-08 01:46:45 +09:00
parent 869147eda0
commit 39790c257b
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
image.go
View File

@ -28,7 +28,7 @@ import (
// Image represents a rectangle set of pixels. // Image represents a rectangle set of pixels.
// The pixel format is alpha-premultiplied RGBA. // 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 { type Image struct {
// addr holds self to check copying. // addr holds self to check copying.
// See strings.Builder for similar examples. // 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 returns the bounds of the image.
//
// Bounds implements the standard image.Image's Bounds.
func (i *Image) Bounds() image.Rectangle { func (i *Image) Bounds() image.Rectangle {
if i.isDisposed() { if i.isDisposed() {
panic("ebiten: the image is already disposed") 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 returns the color model of the image.
//
// ColorModel implements the standard image.Image's ColorModel.
func (i *Image) ColorModel() color.Model { func (i *Image) ColorModel() color.Model {
return color.RGBAModel 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 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. // 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 // 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 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 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. // 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} 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 // RGBA64At loads pixels from GPU to system memory if necessary, which means
// that RGBA64At can be slow. // 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 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. // 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. // In the current implementation, successive calls of Set invokes loading pixels at most once, so this is efficient.