Fix comments

This commit is contained in:
Hajime Hoshi 2018-07-18 02:17:06 +09:00
parent 0593b77eb8
commit 464c575de6

9
run.go
View File

@ -35,11 +35,8 @@ const DefaultTPS = 60
// FPS is deprecated as of 1.8.0-alpha: Use DefaultTPS instead. // FPS is deprecated as of 1.8.0-alpha: Use DefaultTPS instead.
const FPS = DefaultTPS const FPS = DefaultTPS
// CurrentFPS returns the current number of frames per second of rendering. // CurrentFPS returns the current number of FPS (frames per second), that represents
// // how many swapping buffer happens per second.
// The returned value FPS (frames per second) that represents how many times rendering happens in a
// second and NOT TPS (ticks per second) that represents how many times logical game updating (a
// passed function to Run) happens in a second.
// //
// CurrentFPS is concurrent-safe. // CurrentFPS is concurrent-safe.
func CurrentFPS() float64 { func CurrentFPS() float64 {
@ -566,6 +563,8 @@ func MaxTPS() int {
// CurrentTPS returns the current TPS (ticks per second), // CurrentTPS returns the current TPS (ticks per second),
// that represents how many update function is called in a second. // that represents how many update function is called in a second.
//
// CurrentTPS is concurrent safe.
func CurrentTPS() float64 { func CurrentTPS() float64 {
return clock.CurrentTPS() return clock.CurrentTPS()
} }