mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-12-25 11:18:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

ui: Add documents about concurrent-safety

Browse Source 
Fixes #709.
This commit is contained in:
Hajime Hoshi 2018-10-10 23:23:28 +09:00
parent 34596bb1cf
commit 3600c8aa6c
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc.go
View File

@ -45,4 +45,8 @@
// The EBITEN_INTERNAL_IMAGES_KEY environment variable specifies the key
// to dump all the internal images. This is valid only when the build tag
// 'ebitendebug' is specified.
//
// In the API document, 'the main thread' means the goroutine in init(), main() and their callees without 'go'
// statement. It is assured that 'the main thread' runs on the OS main thread. There are some Ebiten functions that
// must be called on the main thread under some conditions (typically, before ebiten.Run is called).
package ebiten

8
run.go
View File

@ -254,7 +254,7 @@ func (i *imageDumper) update(screen *Image) error {
// you can disable this automatical device scaling as a result.
// You can get the device scale by DeviceScaleFactor function.
//
// Run must be called from the OS main thread.
// Run must be called on the main thread.
// Note that Ebiten bounds the main goroutine to the main OS thread by runtime.LockOSThread.
//
// Ebiten tries to call f 60 times a second. In other words,
@ -342,7 +342,7 @@ func RunWithoutMainLoop(f func(*Image) error, width, height int, scale float64,
//
// For actual example, see examples/fullscreen
//
// ScreenSizeInFullscreen is concurrent-safe.
// ScreenSizeInFullscreen must be called on the main thread before ebiten.Run, and is concurrent-safe after ebiten.Run.
func ScreenSizeInFullscreen() (int, int) {
return ui.ScreenSizeInFullscreen()
}
@ -524,7 +524,7 @@ func SetWindowIcon(iconImages []image.Image) {
// DeviceScaleFactor might panic on init function on some devices like Android.
// Then, it is not recommended to call DeviceScaleFactor from init functions.
//
// DeviceScaleFactor is concurrent-safe.
// DeviceScaleFactor must be called on the main thread before ebiten.Run, and is concurrent-safe after ebiten.Run.
func DeviceScaleFactor() float64 {
return ui.DeviceScaleFactor()
}
@ -565,7 +565,7 @@ func MaxTPS() int {
// CurrentTPS returns the current TPS (ticks per second),
// that represents how many update function is called in a second.
//
// CurrentTPS is concurrent safe.
// CurrentTPS is concurrent-safe.
func CurrentTPS() float64 {
return clock.CurrentTPS()
}