mobile

Documentation

Overview

Package mobile provides functions for mobile platforms (Android and iOS).

For usage, see https://github.com/hajimehoshi/ebiten/wiki/Mobile, https://github.com/hajimehoshi/ebiten/wiki/Android and https://github.com/hajimehoshi/ebiten/wiki/iOS.

Index

• func Start(f func(*ebiten.Image) error, width, height int, scale float64, title string) error
• func Update() error
• func UpdateTouchesOnAndroid(action int, id int, x, y int)
• func UpdateTouchesOnIOS(phase int, ptr int64, x, y int)

Functions

func Start

func Start(f func(*ebiten.Image) error, width, height int, scale float64, title string) error

Start starts the game and returns immediately.

Different from ebiten.Run, this invokes only the game loop and not the main (UI) loop.

The unit of width/height is device-independent pixel (dp on Android and point on iOS).

Start always returns nil as of 1.5.0-alpha.

func Update

func Update() error

Update updates and renders the game. This should be called on every frame.

On Android, this should be called at onDrawFrame of Renderer (used by GLSurfaceView).

On iOS, this should be called at glkView:drawInRect: of GLKViewDelegate.

Update returns error when 1) OpenGL error happens, or 2) f in Start returns error samely as ebiten.Run.

func UpdateTouchesOnAndroid

func UpdateTouchesOnAndroid(action int, id int, x, y int)

UpdateTouchesOnAndroid updates the touch state on Android.

This should be called with onTouchEvent of GLSurfaceView like this:

private double mDeviceScale = 0.0;

// pxToDp converts an value in pixels to dp.
private double pxToDp(double x) {
    if (mDeviceScale == 0.0) {
        mDeviceScale = getResources().getDisplayMetrics().density;
    }
    return x / mDeviceScale;
}

@Override
public boolean onTouchEvent(MotionEvent e) {
    for (int i = 0; i < e.getPointerCount(); i++) {
        int id = e.getPointerId(i);
        int x = (int)e.getX(i);
        int y = (int)e.getY(i);
        // Exported function for UpdateTouchesOnAndroid
        YourGame.UpdateTouchesOnAndroid(e.getActionMasked(), id, (int)pxToDp(x), (int)pxToDp(y));
    }
    return true;
}

The coodinate x/y is in dp.

For more details, see https://github.com/hajimehoshi/ebiten/wiki/Android.

func UpdateTouchesOnIOS

func UpdateTouchesOnIOS(phase int, ptr int64, x, y int)

UpdateTouchesOnIOS updates the touch state on iOS.

This should be called with touch handlers of UIViewController like this:

• (GLKView*)glkView { return (GLKView*)[self.view viewWithTag:100]; }
• (void)updateTouches:(NSSet*)touches { for (UITouch* touch in touches) { if (touch.view != [self glkView]) { continue; } CGPoint location = [touch locationInView: [self glkView]]; // Exported function for UpdateTouchesOnIOS YourGameUpdateTouchesOnIOS(touch.phase, (int64_t)touch, location.x, location.y); } }
• (void)touchesBegan:(NSSet*)touches withEvent:(UIEvent*)event { [self updateTouches:touches]; }
• (void)touchesMoved:(NSSet*)touches withEvent:(UIEvent*)event { [self updateTouches:touches]; }
• (void)touchesEnded:(NSSet*)touches withEvent:(UIEvent*)event { [self updateTouches:touches]; }
• (void)touchesCancelled:(NSSet*)touches withEvent:(UIEvent*)event { [self updateTouches:touches]; }

The coodinate x/y is in point.

For more details, see https://github.com/hajimehoshi/ebiten/wiki/iOS.