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 03:41:45 +09:00
parent 34aa52459e
commit 24424d036c
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
image.go
View File

@ -783,11 +783,16 @@ func (i *Image) ColorModel() color.Model {
// ReadPixels reads the image's pixels from the image.
//
// The given pixels represent RGBA pre-multiplied alpha values.
//
// ReadPixels loads pixels from GPU to system memory if necessary, which means that ReadPixels can be slow.
//
// ReadPixels always sets a transparent color if the image is disposed.
//
// len(pixels) must be 4*width*height. If the sizes don't match, ReadPixels panics.
// len(pixels) must be 4 * (bounds width) * (bounds height).
// If len(pixels) is not correct, ReadPixels panics.
//
// ReadPixels also works on a sub-image.
//
// Note that an important logic should not rely on values returned by ReadPixels, since
// the returned values can include very slight differences between some machines.
@ -917,14 +922,14 @@ func (i *Image) Dispose() {
i.setVerticesCache = nil
}
// ReplacePixels replaces the pixels of the image with p.
// ReplacePixels replaces the pixels of the image.
//
// The given p must represent RGBA pre-multiplied alpha values.
// len(pix) must equal to 4 * (bounds width) * (bounds height).
// The given pixels are treated as RGBA pre-multiplied alpha values.
//
// ReplacePixels works on a sub-image.
// len(pix) must be 4 * (bounds width) * (bounds height).
// If len(pix) is not correct, WritePixels panics.
//
// When len(pix) is not appropriate, ReplacePixels panics.
// ReplacePixels also works on a sub-image.
//
// When the image is disposed, ReplacePixels does nothing.
func (i *Image) ReplacePixels(pixels []byte) {