ebiten/internal/ui/ui_glfw.go

680 lines
15 KiB
Go
Raw Normal View History

2015-01-01 17:20:20 +01:00
// Copyright 2015 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.
2014-12-09 15:16:04 +01:00
2017-05-11 12:09:13 +02:00
// +build darwin freebsd linux windows
2015-01-02 07:20:05 +01:00
// +build !js
// +build !android
2016-06-15 17:49:22 +02:00
// +build !ios
2015-01-02 07:20:05 +01:00
2015-01-27 14:02:23 +01:00
package ui
2014-12-05 18:26:02 +01:00
import (
2017-09-22 21:12:02 +02:00
"image"
2017-10-19 20:25:21 +02:00
"math"
2014-12-14 10:57:29 +01:00
"runtime"
2016-09-03 14:14:06 +02:00
"sync"
"time"
2015-06-20 18:33:28 +02:00
2016-09-03 09:25:43 +02:00
"github.com/go-gl/glfw/v3.2/glfw"
2018-01-02 21:22:56 +01:00
"github.com/hajimehoshi/ebiten/internal/devicescale"
"github.com/hajimehoshi/ebiten/internal/hooks"
2018-04-01 16:20:45 +02:00
"github.com/hajimehoshi/ebiten/internal/input"
"github.com/hajimehoshi/ebiten/internal/opengl"
2014-12-05 18:26:02 +01:00
)
type userInterface struct {
2018-01-02 16:23:18 +01:00
title string
window *glfw.Window
width int
windowWidth int
height int
2018-01-02 21:22:56 +01:00
scale float64
fullscreenScale float64
2018-01-02 16:23:18 +01:00
running bool
2018-02-24 16:42:37 +01:00
toChangeSize bool
origPosX int
origPosY int
runnableInBackground bool
2018-01-02 16:23:18 +01:00
initFullscreen bool
initCursorVisible bool
initWindowDecorated bool
initIconImages []image.Image
2018-01-02 16:23:18 +01:00
funcs chan func()
m sync.Mutex
2016-03-24 16:38:30 +01:00
}
2017-07-30 13:26:40 +02:00
var (
currentUI = &userInterface{
origPosX: -1,
origPosY: -1,
initCursorVisible: true,
initWindowDecorated: true,
2017-07-30 13:26:40 +02:00
}
)
2016-03-24 16:38:30 +01:00
2016-07-23 13:25:52 +02:00
func init() {
2017-07-30 13:26:40 +02:00
runtime.LockOSThread()
2018-05-04 16:55:23 +02:00
if err := initialize(); err != nil {
panic(err)
}
2016-07-23 13:25:52 +02:00
}
func initialize() error {
2016-05-07 15:27:10 +02:00
if err := glfw.Init(); err != nil {
2016-07-23 13:25:52 +02:00
return err
2014-12-05 18:26:02 +01:00
}
glfw.WindowHint(glfw.Visible, glfw.False)
2014-12-05 18:26:02 +01:00
glfw.WindowHint(glfw.Resizable, glfw.False)
2016-02-21 09:27:26 +01:00
glfw.WindowHint(glfw.ContextVersionMajor, 2)
glfw.WindowHint(glfw.ContextVersionMinor, 1)
decorated := glfw.False
if currentUI.isInitWindowDecorated() {
decorated = glfw.True
}
glfw.WindowHint(glfw.Decorated, decorated)
2015-02-09 02:25:00 +01:00
// As start, create an window with temporary size to create OpenGL context thread.
window, err := glfw.CreateWindow(16, 16, "", nil, nil)
2014-12-07 20:22:50 +01:00
if err != nil {
2016-07-23 13:25:52 +02:00
return err
2014-12-07 20:22:50 +01:00
}
hideConsoleWindowOnWindows()
2017-07-30 13:26:40 +02:00
currentUI.window = window
currentUI.funcs = make(chan func())
currentUI.window.MakeContextCurrent()
2017-08-12 08:39:41 +02:00
mode := glfw.CursorNormal
if !currentUI.isInitCursorVisible() {
mode = glfw.CursorHidden
}
2017-09-22 21:12:02 +02:00
if i := currentUI.getInitIconImages(); i != nil {
currentUI.window.SetIcon(i)
}
2017-08-12 08:39:41 +02:00
currentUI.window.SetInputMode(glfw.CursorMode, mode)
currentUI.window.SetInputMode(glfw.StickyMouseButtonsMode, glfw.True)
currentUI.window.SetInputMode(glfw.StickyKeysMode, glfw.True)
2016-07-23 13:25:52 +02:00
return nil
}
2016-09-02 17:00:44 +02:00
func RunMainThreadLoop(ch <-chan error) error {
2017-07-30 13:26:40 +02:00
// This must be called on the main thread.
2016-05-06 05:23:48 +02:00
// TODO: Check this is done on the main thread.
2016-09-03 14:14:06 +02:00
currentUI.setRunning(true)
defer func() {
currentUI.setRunning(false)
}()
for {
select {
2016-09-02 16:38:02 +02:00
case f := <-currentUI.funcs:
f()
case err := <-ch:
// ch returns a value not only when an error occur but also it is closed.
return err
}
2016-05-06 05:23:48 +02:00
}
}
2016-09-03 14:14:06 +02:00
func (u *userInterface) isRunning() bool {
u.m.Lock()
v := u.running
u.m.Unlock()
return v
2016-09-03 14:14:06 +02:00
}
func (u *userInterface) setRunning(running bool) {
u.m.Lock()
u.running = running
u.m.Unlock()
}
func (u *userInterface) isInitFullscreen() bool {
u.m.Lock()
v := u.initFullscreen
u.m.Unlock()
return v
}
func (u *userInterface) setInitFullscreen(initFullscreen bool) {
u.m.Lock()
u.initFullscreen = initFullscreen
u.m.Unlock()
2016-09-03 14:14:06 +02:00
}
2017-08-12 08:39:41 +02:00
func (u *userInterface) isInitCursorVisible() bool {
u.m.Lock()
v := u.initCursorVisible
u.m.Unlock()
return v
}
func (u *userInterface) setInitCursorVisible(visible bool) {
u.m.Lock()
u.initCursorVisible = visible
u.m.Unlock()
}
func (u *userInterface) isInitWindowDecorated() bool {
u.m.Lock()
v := u.initWindowDecorated
u.m.Unlock()
return v
}
func (u *userInterface) setInitWindowDecorated(decorated bool) {
u.m.Lock()
u.initWindowDecorated = decorated
u.m.Unlock()
}
func (u *userInterface) isRunnableInBackground() bool {
u.m.Lock()
v := u.runnableInBackground
u.m.Unlock()
return v
}
func (u *userInterface) setRunnableInBackground(runnableInBackground bool) {
u.m.Lock()
u.runnableInBackground = runnableInBackground
u.m.Unlock()
}
2017-09-22 21:12:02 +02:00
func (u *userInterface) getInitIconImages() []image.Image {
u.m.Lock()
i := u.initIconImages
u.m.Unlock()
return i
}
func (u *userInterface) setInitIconImages(iconImages []image.Image) {
u.m.Lock()
u.initIconImages = iconImages
u.m.Unlock()
}
2016-07-23 14:01:30 +02:00
func (u *userInterface) runOnMainThread(f func() error) error {
2016-05-06 05:23:48 +02:00
if u.funcs == nil {
// already closed
2016-07-23 14:01:30 +02:00
return nil
2016-05-06 05:23:48 +02:00
}
ch := make(chan struct{})
2016-07-23 14:01:30 +02:00
var err error
2016-05-06 05:23:48 +02:00
u.funcs <- func() {
2016-07-23 14:01:30 +02:00
err = f()
2016-05-06 05:23:48 +02:00
close(ch)
}
<-ch
2016-07-23 14:01:30 +02:00
return err
2016-05-06 05:23:48 +02:00
}
2018-05-04 09:09:55 +02:00
func MonitorSize() (int, int) {
m := glfw.GetPrimaryMonitor()
v := m.GetVideoMode()
return v.Width, v.Height
}
func SetScreenSize(width, height int) bool {
2016-09-02 16:38:02 +02:00
u := currentUI
2016-09-03 14:14:06 +02:00
if !u.isRunning() {
panic("ui: Run is not called yet")
2016-09-03 14:14:06 +02:00
}
2016-05-06 05:23:48 +02:00
r := false
_ = u.runOnMainThread(func() error {
r = u.setScreenSize(width, height, u.scale, u.fullscreen())
2016-07-23 14:01:30 +02:00
return nil
})
return r
2015-01-27 14:02:23 +01:00
}
func SetScreenScale(scale float64) bool {
2016-09-02 16:38:02 +02:00
u := currentUI
2016-09-03 14:14:06 +02:00
if !u.isRunning() {
panic("ui: Run is not called yet")
2016-09-03 14:14:06 +02:00
}
2016-05-06 05:23:48 +02:00
r := false
_ = u.runOnMainThread(func() error {
r = u.setScreenSize(u.width, u.height, scale, u.fullscreen())
return nil
})
return r
}
2016-09-02 16:38:02 +02:00
func ScreenScale() float64 {
u := currentUI
2016-09-03 14:14:06 +02:00
if !u.isRunning() {
return 0
}
2016-06-18 19:59:17 +02:00
s := 0.0
2016-08-03 16:44:54 +02:00
_ = u.runOnMainThread(func() error {
2016-05-06 05:23:48 +02:00
s = u.scale
2016-07-23 14:01:30 +02:00
return nil
2016-05-06 05:23:48 +02:00
})
return s
2015-01-27 14:02:23 +01:00
}
// fullscreen must be called from the main thread.
func (u *userInterface) fullscreen() bool {
if !u.isRunning() {
panic("not reached")
}
return u.window.GetMonitor() != nil
}
func IsFullscreen() bool {
u := currentUI
if !u.isRunning() {
return u.isInitFullscreen()
}
b := false
_ = u.runOnMainThread(func() error {
b = u.fullscreen()
return nil
})
return b
}
2017-08-02 18:07:04 +02:00
func SetFullscreen(fullscreen bool) {
u := currentUI
if !u.isRunning() {
u.setInitFullscreen(fullscreen)
return
}
_ = u.runOnMainThread(func() error {
u := currentUI
u.setScreenSize(u.width, u.height, u.scale, fullscreen)
return nil
})
}
func SetRunnableInBackground(runnableInBackground bool) {
currentUI.setRunnableInBackground(runnableInBackground)
}
func IsRunnableInBackground() bool {
return currentUI.isRunnableInBackground()
}
2018-05-02 12:09:03 +02:00
func SetWindowTitle(title string) {
if !currentUI.isRunning() {
return
}
_ = currentUI.runOnMainThread(func() error {
currentUI.window.SetTitle(title)
return nil
})
}
func SetWindowIcon(iconImages []image.Image) {
2017-09-22 21:12:02 +02:00
if !currentUI.isRunning() {
currentUI.setInitIconImages(iconImages)
return
}
_ = currentUI.runOnMainThread(func() error {
currentUI.window.SetIcon(iconImages)
return nil
})
}
func ScreenPadding() (x0, y0, x1, y1 float64) {
u := currentUI
if !u.isRunning() {
return 0, 0, 0, 0
}
if !IsFullscreen() {
2017-10-19 20:25:21 +02:00
if u.width == u.windowWidth {
return 0, 0, 0, 0
2017-10-19 20:25:21 +02:00
}
2018-02-24 11:26:14 +01:00
// The window width can be bigger than the game screen width (#444).
ox := (float64(u.windowWidth)*u.actualScreenScale() - float64(u.width)*u.actualScreenScale()) / 2
return ox, 0, ox, 0
}
ox := 0.0
oy := 0.0
m := glfw.GetPrimaryMonitor()
v := m.GetVideoMode()
2018-01-02 21:22:56 +01:00
d := devicescale.DeviceScale()
_ = u.runOnMainThread(func() error {
ox = (float64(v.Width)*d/glfwScale() - float64(u.width)*u.actualScreenScale()) / 2
oy = (float64(v.Height)*d/glfwScale() - float64(u.height)*u.actualScreenScale()) / 2
return nil
})
return ox, oy, ox, oy
}
2018-04-01 16:20:45 +02:00
func AdjustedCursorPosition() (x, y int) {
return adjustCursorPosition(input.Get().CursorPosition())
}
func adjustCursorPosition(x, y int) (int, int) {
u := currentUI
if !u.isRunning() {
return x, y
}
ox, oy, _, _ := ScreenPadding()
s := 0.0
_ = currentUI.runOnMainThread(func() error {
s = currentUI.actualScreenScale()
return nil
})
return x - int(ox/s), y - int(oy/s)
}
func AdjustedTouches() []*input.Touch {
// TODO: Apply adjustCursorPosition
return input.Get().Touches()
}
2017-08-12 08:39:41 +02:00
func IsCursorVisible() bool {
u := currentUI
if !u.isRunning() {
return u.isInitCursorVisible()
}
v := false
_ = currentUI.runOnMainThread(func() error {
v = currentUI.window.GetInputMode(glfw.CursorMode) == glfw.CursorNormal
return nil
})
return v
}
func SetCursorVisible(visible bool) {
2017-08-12 08:39:41 +02:00
u := currentUI
if !u.isRunning() {
u.setInitCursorVisible(visible)
return
}
_ = currentUI.runOnMainThread(func() error {
c := glfw.CursorNormal
if !visible {
c = glfw.CursorHidden
}
currentUI.window.SetInputMode(glfw.CursorMode, c)
return nil
})
2016-09-03 10:17:54 +02:00
}
func IsWindowDecorated() bool {
u := currentUI
if !u.isRunning() {
return u.isInitWindowDecorated()
}
v := false
_ = currentUI.runOnMainThread(func() error {
v = currentUI.window.GetAttrib(glfw.Decorated) == glfw.True
return nil
})
return v
}
func SetWindowDecorated(decorated bool) {
u := currentUI
if !u.isRunning() {
u.setInitWindowDecorated(decorated)
return
}
panic("ui: SetWindowDecorated can't be called after Run so far.")
2018-03-17 10:34:20 +01:00
// TODO: Now SetAttrib doesn't exist on GLFW 3.2. Revisit later (#556).
// If SetAttrib exists, the implementation would be:
//
// _ = currentUI.runOnMainThread(func() error {
// v := glfw.False
// if decorated {
// v = glfw.True
// }
// currentUI.window.SetAttrib(glfw.Decorated, v)
// return nil
}
func Run(width, height int, scale float64, title string, g GraphicsContext, mainloop bool) error {
2016-09-02 17:20:05 +02:00
u := currentUI
2016-07-23 21:32:12 +02:00
// GLContext must be created before setting the screen size, which requires
2016-07-23 15:17:36 +02:00
// swapping buffers.
opengl.Init(currentUI.runOnMainThread)
2017-10-19 20:25:21 +02:00
_ = u.runOnMainThread(func() error {
2016-05-06 05:23:48 +02:00
m := glfw.GetPrimaryMonitor()
v := m.GetVideoMode()
// The game is in window mode (not fullscreen mode) at the first state.
// Don't refer u.initFullscreen here to avoid some GLFW problems.
2017-10-19 20:25:21 +02:00
u.setScreenSize(width, height, scale, false)
u.title = title
2016-05-06 05:23:48 +02:00
u.window.SetTitle(title)
u.window.Show()
2014-12-14 10:57:29 +01:00
2016-07-04 04:37:34 +02:00
w, h := u.glfwSize()
x := (v.Width - w) / 2
y := (v.Height - h) / 3
x, y = adjustWindowPosition(x, y)
2016-05-06 05:23:48 +02:00
u.window.SetPos(x, y)
2016-07-23 14:01:30 +02:00
return nil
2017-10-19 20:25:21 +02:00
})
2016-09-01 19:31:03 +02:00
return u.loop(g)
}
2018-02-24 16:00:59 +01:00
// getSize must be called from the main thread.
2017-10-19 19:05:05 +02:00
func (u *userInterface) glfwSize() (int, int) {
w := int(float64(u.windowWidth) * u.getScale() * glfwScale())
h := int(float64(u.height) * u.getScale() * glfwScale())
2017-10-19 19:05:05 +02:00
return w, h
2016-02-26 17:35:14 +01:00
}
2018-02-24 16:00:59 +01:00
// getScale must be called from the main thread.
func (u *userInterface) getScale() float64 {
if !u.fullscreen() {
return u.scale
}
if u.fullscreenScale == 0 {
m := glfw.GetPrimaryMonitor()
v := m.GetVideoMode()
sw := float64(v.Width) / glfwScale() / float64(u.width)
sh := float64(v.Height) / glfwScale() / float64(u.height)
s := sw
if s > sh {
s = sh
}
u.fullscreenScale = s
}
return u.fullscreenScale
}
2018-02-24 16:00:59 +01:00
// actualScreenScale must be called from the main thread.
2016-06-18 19:59:17 +02:00
func (u *userInterface) actualScreenScale() float64 {
2018-01-02 21:22:56 +01:00
return u.getScale() * devicescale.DeviceScale()
2015-01-01 17:20:20 +01:00
}
2018-02-24 16:00:59 +01:00
// pollEvents must be called from the main thread.
2017-03-03 03:15:07 +01:00
func (u *userInterface) pollEvents() {
2014-12-06 14:56:57 +01:00
glfw.PollEvents()
2018-04-01 16:20:45 +02:00
input.Get().Update(u.window, u.getScale()*glfwScale())
2014-12-05 18:26:02 +01:00
}
func (u *userInterface) updateGraphicsContext(g GraphicsContext) {
actualScale := 0.0
sizeChanged := false
2018-02-24 06:50:45 +01:00
// TODO: Is it possible to reduce 'runOnMainThread' calls?
_ = u.runOnMainThread(func() error {
2018-02-24 16:42:37 +01:00
if !u.toChangeSize {
return nil
}
2018-02-24 16:42:37 +01:00
u.toChangeSize = false
actualScale = u.actualScreenScale()
sizeChanged = true
return nil
})
if sizeChanged {
g.SetSize(u.width, u.height, actualScale)
}
}
2016-09-01 17:53:05 +02:00
func (u *userInterface) update(g GraphicsContext) error {
2016-05-17 18:30:27 +02:00
shouldClose := false
2016-08-03 16:44:54 +02:00
_ = u.runOnMainThread(func() error {
2016-05-17 18:30:27 +02:00
shouldClose = u.window.ShouldClose()
2016-07-23 14:01:30 +02:00
return nil
2016-05-17 18:30:27 +02:00
})
if shouldClose {
return RegularTermination
2016-05-17 18:30:27 +02:00
}
_ = u.runOnMainThread(func() error {
if u.isInitFullscreen() {
u := currentUI
u.setScreenSize(u.width, u.height, u.scale, true)
u.setInitFullscreen(false)
}
return nil
})
// This call is needed for initialization.
u.updateGraphicsContext(g)
2017-03-03 03:15:07 +01:00
_ = u.runOnMainThread(func() error {
u.pollEvents()
defer hooks.ResumeAudio()
for !u.isRunnableInBackground() && u.window.GetAttrib(glfw.Focused) == 0 {
hooks.SuspendAudio()
2016-05-06 05:23:48 +02:00
// Wait for an arbitrary period to avoid busy loop.
time.Sleep(time.Second / 60)
2017-03-03 03:15:07 +01:00
u.pollEvents()
2016-05-06 05:23:48 +02:00
if u.window.ShouldClose() {
2016-07-23 14:01:30 +02:00
return nil
2016-05-06 05:23:48 +02:00
}
}
2016-07-23 14:01:30 +02:00
return nil
2017-03-03 03:15:07 +01:00
})
if err := g.Update(func() {
2018-04-01 16:20:45 +02:00
input.Get().ClearRuneBuffer()
2018-06-17 17:38:30 +02:00
input.Get().ResetScrollValues()
// The offscreens must be updated every frame (#490).
u.updateGraphicsContext(g)
}); err != nil {
2016-09-01 17:53:05 +02:00
return err
}
return nil
}
2016-09-01 19:31:03 +02:00
func (u *userInterface) loop(g GraphicsContext) error {
2016-09-01 18:07:41 +02:00
defer func() {
_ = u.runOnMainThread(func() error {
glfw.Terminate()
return nil
})
}()
for {
2016-09-01 17:53:05 +02:00
if err := u.update(g); err != nil {
return err
}
2018-01-06 15:53:35 +01:00
// The bound framebuffer must be the original screen framebuffer
// before swapping buffers.
opengl.GetContext().BindScreenFramebuffer()
_ = u.runOnMainThread(func() error {
u.swapBuffers()
return nil
})
2016-07-23 14:01:30 +02:00
}
2016-03-26 09:24:40 +01:00
}
2018-02-24 16:00:59 +01:00
// swapBuffers must be called from the main thread.
func (u *userInterface) swapBuffers() {
u.window.SwapBuffers()
2014-12-14 10:57:29 +01:00
}
2015-02-09 02:25:00 +01:00
2018-02-24 16:00:59 +01:00
// setScreenSize must be called from the main thread.
func (u *userInterface) setScreenSize(width, height int, scale float64, fullscreen bool) bool {
if u.width == width && u.height == height && u.scale == scale && u.fullscreen() == fullscreen {
return false
2015-02-09 02:25:00 +01:00
}
// On Windows, giving a too small width doesn't call a callback (#165).
// To prevent hanging up, return asap if the width is too small.
// 252 is an arbitrary number and I guess this is small enough.
const minWindowWidth = 252
2017-10-19 20:25:21 +02:00
u.width = width
u.windowWidth = width
2018-01-02 21:22:56 +01:00
s := scale * devicescale.DeviceScale()
2017-10-19 20:25:21 +02:00
if int(float64(width)*s) < minWindowWidth {
u.windowWidth = int(math.Ceil(minWindowWidth / s))
}
2017-10-19 20:25:21 +02:00
u.height = height
u.scale = scale
u.fullscreenScale = 0
2015-02-09 02:25:00 +01:00
// To make sure the current existing framebuffers are rendered,
// swap buffers here before SetSize is called.
u.swapBuffers()
if fullscreen {
if u.origPosX < 0 && u.origPosY < 0 {
2017-07-01 06:03:27 +02:00
u.origPosX, u.origPosY = u.window.GetPos()
}
m := glfw.GetPrimaryMonitor()
v := m.GetVideoMode()
2017-07-01 06:03:27 +02:00
u.window.SetMonitor(m, 0, 0, v.Width, v.Height, v.RefreshRate)
} else {
if u.origPosX >= 0 && u.origPosY >= 0 {
x := u.origPosX
y := u.origPosY
2017-07-01 06:03:27 +02:00
u.window.SetMonitor(nil, x, y, 16, 16, 0)
u.origPosX = -1
u.origPosY = -1
}
2017-10-19 20:25:21 +02:00
oldW, oldH := u.window.GetSize()
newW, newH := u.glfwSize()
if oldW != newW || oldH != newH {
ch := make(chan struct{})
u.window.SetFramebufferSizeCallback(func(_ *glfw.Window, _, _ int) {
u.window.SetFramebufferSizeCallback(nil)
close(ch)
})
u.window.SetSize(u.glfwSize())
event:
for {
glfw.PollEvents()
select {
case <-ch:
break event
default:
}
}
2015-02-09 02:25:00 +01:00
}
2017-10-19 19:05:05 +02:00
// Window title might be lost on macOS after coming back from fullscreen.
u.window.SetTitle(u.title)
2015-02-09 02:25:00 +01:00
}
// SwapInterval is affected by the current monitor of the window.
// This needs to be called at least after SetMonitor.
2017-07-01 06:03:27 +02:00
// Without SwapInterval after SetMonitor, vsynch doesn't work (#375).
2017-08-12 08:39:41 +02:00
//
// TODO: (#405) If triple buffering is needed, SwapInterval(0) should be called,
// but is this correct? If glfw.SwapInterval(0) and the driver doesn't support triple
// buffering, what will happen?
glfw.SwapInterval(1)
2017-08-12 08:39:41 +02:00
2018-02-24 16:42:37 +01:00
u.toChangeSize = true
return true
2015-02-09 02:25:00 +01:00
}