ebiten/internal/uidriver/mobile/ui.go

459 lines
9.8 KiB
Go
Raw Normal View History

// Copyright 2016 Hajime Hoshi
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
2017-01-25 17:32:33 +01:00
// +build android ios
package mobile
import (
"context"
"fmt"
2017-09-22 21:12:02 +02:00
"image"
"runtime/debug"
"sync"
"time"
2016-05-19 16:37:58 +02:00
"golang.org/x/mobile/app"
"golang.org/x/mobile/event/lifecycle"
"golang.org/x/mobile/event/paint"
"golang.org/x/mobile/event/size"
"golang.org/x/mobile/event/touch"
"golang.org/x/mobile/gl"
2018-01-02 21:22:56 +01:00
"github.com/hajimehoshi/ebiten/internal/devicescale"
"github.com/hajimehoshi/ebiten/internal/driver"
"github.com/hajimehoshi/ebiten/internal/graphicsdriver/opengl"
"github.com/hajimehoshi/ebiten/internal/thread"
)
var (
glContextCh = make(chan gl.Context)
2019-05-30 18:44:01 +02:00
2019-07-31 18:07:19 +02:00
// renderCh receives when updating starts.
2019-05-30 18:44:01 +02:00
renderCh = make(chan struct{})
// renderEndCh receives when updating finishes.
renderEndCh = make(chan struct{})
theUI = &UserInterface{}
)
2019-04-07 12:27:30 +02:00
func init() {
theUI.input.ui = theUI
}
func Get() *UserInterface {
return theUI
}
2019-06-07 18:53:39 +02:00
func (u *UserInterface) Render() {
renderCh <- struct{}{}
ctx, cancel := context.WithCancel(context.Background())
go func() {
<-renderEndCh
if u.t != nil {
u.t.Call(func() error {
cancel()
return nil
})
} else {
cancel()
}
}()
if u.graphics.IsGL() {
if u.glWorker == nil {
panic("mobile: glWorker must be initialized but not")
}
workAvailable := u.glWorker.WorkAvailable()
loop:
for {
select {
case <-workAvailable:
u.glWorker.DoWork()
case <-ctx.Done():
break loop
}
}
return
} else {
u.t.Loop(ctx)
}
}
type UserInterface struct {
2016-06-18 17:55:24 +02:00
width int
height int
2016-06-18 19:59:17 +02:00
scale float64
2016-06-18 17:55:24 +02:00
sizeChanged bool
2018-03-23 17:07:36 +01:00
// Used for gomobile-build
fullscreenScale float64
fullscreenWidthPx int
fullscreenHeightPx int
graphics driver.Graphics
input Input
t *thread.Thread
glWorker gl.Worker
m sync.RWMutex
}
func deviceScale() float64 {
return devicescale.GetAt(0, 0)
2018-10-01 20:51:13 +02:00
}
// appMain is the main routine for gomobile-build mode.
2019-04-08 00:51:32 +02:00
func (u *UserInterface) appMain(a app.App) {
var glctx gl.Context
2019-04-08 01:21:17 +02:00
touches := map[touch.Sequence]*Touch{}
for e := range a.Events() {
switch e := a.Filter(e).(type) {
case lifecycle.Event:
switch e.Crosses(lifecycle.StageVisible) {
case lifecycle.CrossOn:
glctx, _ = e.DrawContext.(gl.Context)
// Assume that glctx is always a same instance.
// Then, only once initializing should be enough.
if glContextCh != nil {
glContextCh <- glctx
glContextCh = nil
}
a.Send(paint.Event{})
case lifecycle.CrossOff:
glctx = nil
}
case size.Event:
2019-04-08 00:51:32 +02:00
u.setFullscreenImpl(e.WidthPx, e.HeightPx)
case paint.Event:
if glctx == nil || e.External {
continue
}
renderCh <- struct{}{}
2019-05-30 18:44:01 +02:00
<-renderEndCh
a.Publish()
a.Send(paint.Event{})
case touch.Event:
switch e.Type {
case touch.TypeBegin, touch.TypeMove:
s := deviceScale()
x, y := float64(e.X)/s, float64(e.Y)/s
// TODO: Is it ok to cast from int64 to int here?
2019-04-08 01:21:17 +02:00
touches[e.Sequence] = &Touch{
ID: int(e.Sequence),
X: int(x),
Y: int(y),
}
case touch.TypeEnd:
delete(touches, e.Sequence)
}
2019-04-08 01:21:17 +02:00
ts := []*Touch{}
for _, t := range touches {
ts = append(ts, t)
}
2019-04-08 00:51:32 +02:00
u.input.update(ts)
}
}
}
2016-05-19 16:37:58 +02:00
func (u *UserInterface) Run(width, height int, scale float64, title string, context driver.UIContext, graphics driver.Graphics) error {
go func() {
if err := u.run(width, height, scale, title, context, graphics, true); err != nil {
// As mobile apps never ends, Loop can't return. Just panic here.
panic(err)
}
}()
app.Main(u.appMain)
return nil
}
func (u *UserInterface) RunWithoutMainLoop(width, height int, scale float64, title string, context driver.UIContext, graphics driver.Graphics) <-chan error {
ch := make(chan error)
go func() {
defer close(ch)
if err := u.run(width, height, scale, title, context, graphics, false); err != nil {
ch <- err
}
}()
return ch
}
func (u *UserInterface) run(width, height int, scale float64, title string, context driver.UIContext, graphics driver.Graphics, mainloop bool) (err error) {
// Convert the panic to a regular error so that Java/Objective-C layer can treat this easily e.g., for
// Crashlytics. A panic is treated as SIGABRT, and there is no way to handle this on Java/Objective-C layer
// unfortunately.
// TODO: Panic on other goroutines cannot be handled here.
defer func() {
if r := recover(); r != nil {
err = fmt.Errorf("%v\n%q", r, string(debug.Stack()))
}
}()
u.m.Lock()
2016-05-19 16:37:58 +02:00
u.width = width
u.height = height
u.scale = scale
u.sizeChanged = true
u.graphics = graphics
u.m.Unlock()
2016-05-19 16:37:58 +02:00
// title is ignored?
2018-03-23 17:07:36 +01:00
if graphics.IsGL() {
var ctx gl.Context
if mainloop {
ctx = <-glContextCh
} else {
ctx, u.glWorker = gl.NewContext()
}
graphics.(*opengl.Driver).SetMobileGLContext(ctx)
} else {
u.t = thread.New()
graphics.SetThread(u.t)
}
2018-03-23 17:07:36 +01:00
2018-05-26 15:50:58 +02:00
// Force to set the screen size
u.updateSize(context)
for {
if err := u.update(context); err != nil {
return err
}
2016-09-01 18:34:51 +02:00
}
}
func (u *UserInterface) updateSize(context driver.UIContext) {
width, height := 0, 0
actualScale := 0.0
u.m.Lock()
2018-05-11 19:29:39 +02:00
sizeChanged := u.sizeChanged
if sizeChanged {
width = u.width
height = u.height
actualScale = u.scaleImpl() * deviceScale()
}
u.sizeChanged = false
u.m.Unlock()
if sizeChanged {
2016-09-01 18:34:51 +02:00
// Sizing also calls GL functions
context.SetSize(width, height, actualScale)
}
}
func (u *UserInterface) ActualScale() float64 {
2018-03-23 17:07:36 +01:00
u.m.Lock()
s := u.scaleImpl() * deviceScale()
2018-03-23 17:07:36 +01:00
u.m.Unlock()
return s
}
func (u *UserInterface) scaleImpl() float64 {
2018-03-23 17:07:36 +01:00
scale := u.scale
if u.fullscreenScale != 0 {
scale = u.fullscreenScale
}
return scale
2018-03-23 17:07:36 +01:00
}
func (u *UserInterface) update(context driver.UIContext) error {
t := time.NewTimer(500 * time.Millisecond)
defer t.Stop()
select {
case <-renderCh:
case <-t.C:
context.SuspendAudio()
<-renderCh
}
context.ResumeAudio()
defer func() {
2019-05-30 18:44:01 +02:00
renderEndCh <- struct{}{}
}()
if err := context.Update(func() {
u.updateSize(context)
}); err != nil {
2016-09-01 18:34:51 +02:00
return err
}
return nil
}
func (u *UserInterface) ScreenSize() (int, int) {
2018-03-23 17:07:36 +01:00
u.m.Lock()
w, h := u.width, u.height
u.m.Unlock()
return w, h
}
func (u *UserInterface) ScreenSizeInFullscreen() (int, int) {
2018-05-04 09:09:55 +02:00
// TODO: This function should return fullscreenWidthPx, fullscreenHeightPx,
// but these values are not initialized until the main loop starts.
return 0, 0
}
func (u *UserInterface) SetScreenSize(width, height int) {
u.m.Lock()
if u.width != width || u.height != height {
u.width = width
u.height = height
2018-03-23 17:07:36 +01:00
u.updateFullscreenScaleIfNeeded()
u.sizeChanged = true
}
u.m.Unlock()
}
func (u *UserInterface) SetScreenScale(scale float64) {
u.m.Lock()
if u.scale != scale {
u.scale = scale
u.sizeChanged = true
}
u.m.Unlock()
}
func (u *UserInterface) ScreenScale() float64 {
u.m.RLock()
s := u.scale
u.m.RUnlock()
return s
2016-05-19 16:37:58 +02:00
}
func (u *UserInterface) setFullscreenImpl(widthPx, heightPx int) {
// This implementation is only for gomobile-build so far.
2018-03-23 17:07:36 +01:00
u.m.Lock()
u.fullscreenWidthPx = widthPx
u.fullscreenHeightPx = heightPx
u.updateFullscreenScaleIfNeeded()
u.sizeChanged = true
u.m.Unlock()
}
func (u *UserInterface) updateFullscreenScaleIfNeeded() {
2018-03-23 17:07:36 +01:00
if u.fullscreenWidthPx == 0 || u.fullscreenHeightPx == 0 {
return
}
w, h := u.width, u.height
scaleX := float64(u.fullscreenWidthPx) / float64(w)
scaleY := float64(u.fullscreenHeightPx) / float64(h)
scale := scaleX
if scale > scaleY {
scale = scaleY
}
u.fullscreenScale = scale / deviceScale()
u.sizeChanged = true
2018-03-23 17:07:36 +01:00
}
func (u *UserInterface) ScreenPadding() (x0, y0, x1, y1 float64) {
2018-03-23 17:07:36 +01:00
u.m.Lock()
x0, y0, x1, y1 = u.screenPaddingImpl()
u.m.Unlock()
return
}
func (u *UserInterface) screenPaddingImpl() (x0, y0, x1, y1 float64) {
2018-03-23 17:07:36 +01:00
if u.fullscreenScale == 0 {
return 0, 0, 0, 0
}
s := u.fullscreenScale * deviceScale()
2018-03-23 17:07:36 +01:00
ox := (float64(u.fullscreenWidthPx) - float64(u.width)*s) / 2
oy := (float64(u.fullscreenHeightPx) - float64(u.height)*s) / 2
return ox, oy, ox, oy
}
2019-04-07 12:27:30 +02:00
func (u *UserInterface) adjustPosition(x, y int) (int, int) {
2018-03-23 17:07:36 +01:00
ox, oy, _, _ := u.screenPaddingImpl()
s := u.scaleImpl()
as := s * deviceScale()
return int(float64(x)/s - ox/as), int(float64(y)/s - oy/as)
}
func (u *UserInterface) IsCursorVisible() bool {
2017-08-12 08:39:41 +02:00
return false
}
func (u *UserInterface) SetCursorVisible(visible bool) {
2016-09-03 10:17:54 +02:00
// Do nothing
}
func (u *UserInterface) IsFullscreen() bool {
return false
}
func (u *UserInterface) SetFullscreen(fullscreen bool) {
// Do nothing
}
func (u *UserInterface) IsRunnableInBackground() bool {
return false
}
func (u *UserInterface) SetRunnableInBackground(runnableInBackground bool) {
// Do nothing
}
func (u *UserInterface) SetWindowTitle(title string) {
2018-05-02 12:09:03 +02:00
// Do nothing
}
func (u *UserInterface) SetWindowIcon(iconImages []image.Image) {
// Do nothing
}
func (u *UserInterface) IsWindowDecorated() bool {
return false
}
func (u *UserInterface) SetWindowDecorated(decorated bool) {
2017-09-22 21:12:02 +02:00
// Do nothing
}
func (u *UserInterface) IsWindowResizable() bool {
return false
}
func (u *UserInterface) SetWindowResizable(decorated bool) {
// Do nothing
}
func (u *UserInterface) IsVsyncEnabled() bool {
return true
}
func (u *UserInterface) SetVsyncEnabled(enabled bool) {
// Do nothing
}
func (u *UserInterface) DeviceScaleFactor() float64 {
return deviceScale()
}
2019-04-07 11:28:50 +02:00
func (u *UserInterface) Input() driver.Input {
return &u.input
}
2019-04-08 01:21:17 +02:00
type Touch struct {
ID int
X int
Y int
}
func (u *UserInterface) UpdateInput(touches []*Touch) {
u.input.update(touches)
2019-04-07 11:28:50 +02:00
}