mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-12-26 03:38:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

graphics: Add 'concurrent-safe' comments

Browse Source
This commit is contained in:
Hajime Hoshi 2016-04-08 04:09:43 +09:00
parent 92e56d53f1
commit 9e58128ea8
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
image.go
View File

@ -42,11 +42,15 @@ type Image struct {
} }
// Size returns the size of the image. // Size returns the size of the image.
//
// This function is concurrent-safe.
func (i *Image) Size() (width, height int) { func (i *Image) Size() (width, height int) {
return i.width, i.height return i.width, i.height
} }
// Clear resets the pixels of the image into 0. // Clear resets the pixels of the image into 0.
//
// This function is concurrent-safe.
func (i *Image) Clear() (err error) { func (i *Image) Clear() (err error) {
imageM.Lock() imageM.Lock()
defer imageM.Unlock() defer imageM.Unlock()
@ -58,6 +62,8 @@ func (i *Image) clear() (err error) {
} }
// Fill fills the image with a solid color. // Fill fills the image with a solid color.
//
// This function is concurrent-safe.
func (i *Image) Fill(clr color.Color) (err error) { func (i *Image) Fill(clr color.Color) (err error) {
imageM.Lock() imageM.Lock()
defer imageM.Unlock() defer imageM.Unlock()
@ -87,6 +93,8 @@ func (i *Image) fill(clr color.Color) (err error) {
// //
// Be careful that this method is potentially slow. // Be careful that this method is potentially slow.
// It would be better if you could call this method fewer times. // It would be better if you could call this method fewer times.
//
// This function is concurrent-safe.
func (i *Image) DrawImage(image *Image, options *DrawImageOptions) (err error) { func (i *Image) DrawImage(image *Image, options *DrawImageOptions) (err error) {
// Calculate vertices before locking because the user can do anything in // Calculate vertices before locking because the user can do anything in
// options.ImageParts interface without deadlock (e.g. Call Image functions). // options.ImageParts interface without deadlock (e.g. Call Image functions).
@ -125,11 +133,15 @@ func (i *Image) DrawImage(image *Image, options *DrawImageOptions) (err error) {
} }
// Bounds returns the bounds of the image. // Bounds returns the bounds of the image.
//
// This function is concurrent-safe.
func (i *Image) Bounds() image.Rectangle { func (i *Image) Bounds() image.Rectangle {
return image.Rect(0, 0, i.width, i.height) return image.Rect(0, 0, i.width, i.height)
} }
// ColorModel returns the color model of the image. // ColorModel returns the color model of the image.
//
// This function is concurrent-safe.
func (i *Image) ColorModel() color.Model { func (i *Image) ColorModel() color.Model {
return color.RGBAModel return color.RGBAModel
} }
@ -137,6 +149,8 @@ func (i *Image) ColorModel() color.Model {
// At returns the color of the image at (x, y). // At returns the color of the image at (x, y).
// //
// This method loads pixels from VRAM to system memory if necessary. // This method loads pixels from VRAM to system memory if necessary.
//
// This function is concurrent-safe.
func (i *Image) At(x, y int) color.Color { func (i *Image) At(x, y int) color.Color {
// TODO: What if At is called internaly (like from image parts?) // TODO: What if At is called internaly (like from image parts?)
imageM.Lock() imageM.Lock()
@ -161,6 +175,8 @@ func (i *Image) At(x, y int) color.Color {
// This is useful to save memory. // This is useful to save memory.
// //
// The behavior of any functions for a disposed image is undefined. // The behavior of any functions for a disposed image is undefined.
//
// This function is concurrent-safe.
func (i *Image) Dispose() error { func (i *Image) Dispose() error {
imageM.Lock() imageM.Lock()
defer imageM.Unlock() defer imageM.Unlock()
@ -192,6 +208,8 @@ func (i *Image) isDisposed() bool {
// The given p must represent RGBA pre-multiplied alpha values. len(p) must equal to 4 * (image width) * (image height). // The given p must represent RGBA pre-multiplied alpha values. len(p) must equal to 4 * (image width) * (image height).
// //
// This function may be slow (as for implementation, this calls glTexSubImage2D). // This function may be slow (as for implementation, this calls glTexSubImage2D).
//
// This function is concurrent-safe.
func (i *Image) ReplacePixels(p []uint8) error { func (i *Image) ReplacePixels(p []uint8) error {
imageM.Lock() imageM.Lock()
defer imageM.Unlock() defer imageM.Unlock()