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

docs: Add comment to IsRunningSlowly

Browse Source
This commit is contained in:
Hajime Hoshi 2018-02-03 00:55:38 +09:00
parent 92f4388dfd
commit 35bbee9307
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
run.go
View File

@ -54,6 +54,17 @@ func setRunningSlowly(slow bool) {
// It is recommended to skip heavy processing, especially drawing screen, // It is recommended to skip heavy processing, especially drawing screen,
// when IsRunningSlowly is true. // when IsRunningSlowly is true.
// //
// The typical code with IsRunningSlowly is this:
//
// func update(screen *ebiten.Image) error {
// // update the state
// if ebiten.IsRunningSlowly() {
// return nil
// }
// // draw something to the screen
// return nil
// }
//
// This function is concurrent-safe. // This function is concurrent-safe.
func IsRunningSlowly() bool { func IsRunningSlowly() bool {
return atomic.LoadInt32(&isRunningSlowly) != 0 return atomic.LoadInt32(&isRunningSlowly) != 0