mobile: Add comments when to call functions

This commit is contained in:
Hajime Hoshi 2018-05-04 00:44:03 +09:00
parent fd43848568
commit 6d1342a934

View File

@ -53,6 +53,8 @@ func Start(f func(*ebiten.Image) error, width, height int, scale float64, title
// Update updates and renders the game. // Update updates and renders the game.
// This should be called on every frame. // This should be called on every frame.
// //
// If Update is called before Start is called, Update panics.
//
// On Android, this should be called at onDrawFrame of Renderer (used by GLSurfaceView). // On Android, this should be called at onDrawFrame of Renderer (used by GLSurfaceView).
// //
// On iOS, this should be called at glkView:drawInRect: of GLKViewDelegate. // On iOS, this should be called at glkView:drawInRect: of GLKViewDelegate.
@ -95,6 +97,8 @@ func Update() error {
// //
// The coodinate x/y is in dp. // The coodinate x/y is in dp.
// //
// UpdateTouchesOnAndroid can be called even before Start is called.
//
// UpdateTouchesOnAndroid is concurrent-safe. // UpdateTouchesOnAndroid is concurrent-safe.
// //
// For more details, see https://github.com/hajimehoshi/ebiten/wiki/Android. // For more details, see https://github.com/hajimehoshi/ebiten/wiki/Android.
@ -137,6 +141,8 @@ func UpdateTouchesOnAndroid(action int, id int, x, y int) {
// //
// The coodinate x/y is in point. // The coodinate x/y is in point.
// //
// UpdateTouchesOnIOS can be called even before Start is called.
//
// UpdateTouchesOnIOS is concurrent-safe. // UpdateTouchesOnIOS is concurrent-safe.
// //
// For more details, see https://github.com/hajimehoshi/ebiten/wiki/iOS. // For more details, see https://github.com/hajimehoshi/ebiten/wiki/iOS.