ebiten/run.go

484 lines
16 KiB
Go
Raw Normal View History

// Copyright 2014 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
2014-12-14 08:53:32 +01:00
package ebiten
2014-12-06 17:09:59 +01:00
import (
2016-07-03 09:18:29 +02:00
"sync/atomic"
2017-08-05 19:15:27 +02:00
"github.com/hajimehoshi/ebiten/internal/clock"
"github.com/hajimehoshi/ebiten/internal/driver"
)
// Game defines necessary functions for a game.
type Game interface {
// Update updates a game by one frame.
Update(*Image) error
// Layout accepts a native outside size in device-independent pixels and returns the game's logical screen
// size.
//
2019-12-21 19:50:30 +01:00
// On desktops, the outside is a window or a monitor (fullscreen mode). On browsers, the outside is a body
// element. On mobiles, the outside is the phone's entire screen.
//
// The screen scale is automatically adjusted to fit the outside.
//
// Layout is called almost every frame.
//
// If Layout returns non-positive numbers, the caller can panic.
//
// You can return a fixed screen size if you don't care, or you can also return a calculated screen size
// adjusted with the given outside size.
Layout(outsideWidth, outsideHeight int) (screenWidth, screenHeight int)
}
// TPS represents a default ticks per second, that represents how many times game updating happens in a second.
const DefaultTPS = 60
2018-07-16 17:52:50 +02:00
// FPS is deprecated as of 1.8.0-alpha: Use DefaultTPS instead.
const FPS = DefaultTPS
2016-03-26 09:50:00 +01:00
2018-07-17 19:17:06 +02:00
// CurrentFPS returns the current number of FPS (frames per second), that represents
// how many swapping buffer happens per second.
2017-09-30 18:59:34 +02:00
//
// On some environments, CurrentFPS doesn't return a reliable value since vsync doesn't work well there.
// If you want to measure the application's speed, Use CurrentTPS.
//
// CurrentFPS is concurrent-safe.
2016-03-26 09:50:00 +01:00
func CurrentFPS() float64 {
2017-08-05 19:17:26 +02:00
return clock.CurrentFPS()
2016-03-26 09:50:00 +01:00
}
2016-07-03 09:18:29 +02:00
var (
isDrawingSkipped = int32(0)
currentMaxTPS = int32(DefaultTPS)
2016-07-03 09:18:29 +02:00
)
func setDrawingSkipped(skipped bool) {
2016-07-03 09:18:29 +02:00
v := int32(0)
if skipped {
2016-07-03 09:18:29 +02:00
v = 1
}
atomic.StoreInt32(&isDrawingSkipped, v)
2016-07-03 09:18:29 +02:00
}
2018-07-11 04:06:18 +02:00
// IsDrawingSkipped returns true if rendering result is not adopted.
// It is recommended to skip drawing images or screen
// when IsDrawingSkipped is true.
2016-03-26 10:46:07 +01:00
//
// The typical code with IsDrawingSkipped is this:
2018-02-02 16:55:38 +01:00
//
// func update(screen *ebiten.Image) error {
//
// // Update the state.
//
// // When IsDrawingSkipped is true, the rendered result is not adopted.
// // Skip rendering then.
// if ebiten.IsDrawingSkipped() {
2018-02-02 16:55:38 +01:00
// return nil
// }
//
// // Draw something to the screen.
//
2018-02-02 16:55:38 +01:00
// return nil
// }
//
// IsDrawingSkipped is concurrent-safe.
func IsDrawingSkipped() bool {
return atomic.LoadInt32(&isDrawingSkipped) != 0
}
// IsRunningSlowly is deprecated as of 1.8.0-alpha.
// Use IsDrawingSkipped instead.
2016-03-26 09:50:00 +01:00
func IsRunningSlowly() bool {
return IsDrawingSkipped()
2016-03-26 09:50:00 +01:00
}
// Run starts the main loop and runs the game.
2016-03-26 09:50:00 +01:00
// f is a function which is called at every frame.
// The argument (*Image) is the render target that represents the screen.
2017-09-30 18:59:34 +02:00
// The screen size is based on the given values (width and height).
//
// Run is a shorthand for RunGame, but there are some restrictions.
// If you want to resize the window by dragging, use RunGame instead.
//
2017-09-30 18:59:34 +02:00
// A window size is based on the given values (width, height and scale).
//
// scale is used to enlarge the screen on desktops.
// scale is ignored on browsers or mobiles.
2018-01-03 08:52:41 +01:00
// Note that the actual screen is multiplied not only by the given scale but also
// by the device scale on high-DPI display.
// If you pass inverse of the device scale,
// you can disable this automatical device scaling as a result.
// You can get the device scale by DeviceScaleFactor function.
2016-03-26 09:50:00 +01:00
//
// On browsers, the scale is automatically adjusted.
// It is strongly recommended to use iframe if you embed an Ebiten application in your website.
2019-10-21 21:15:15 +02:00
// scale works as this as of 1.10.0-alpha.
2019-10-21 21:07:14 +02:00
// Before that, scale affected the rendering scale.
//
// On mobiles, if you use ebitenmobile command, the scale is automatically adjusted.
//
// Run must be called on the main thread.
2017-09-30 18:59:34 +02:00
// Note that Ebiten bounds the main goroutine to the main OS thread by runtime.LockOSThread.
2016-03-26 09:50:00 +01:00
//
2019-01-13 15:25:32 +01:00
// Ebiten tries to call f 60 times a second by default. In other words,
// TPS (ticks per second) is 60 by default.
2018-07-15 21:39:05 +02:00
// This is not related to framerate (display's refresh rate).
2018-07-15 21:36:47 +02:00
//
2017-09-30 18:59:34 +02:00
// f is not called when the window is in background by default.
// This setting is configurable with SetRunnableInBackground.
//
2018-03-23 17:07:36 +01:00
// The given scale is ignored on fullscreen mode or gomobile-build mode.
2017-07-01 06:07:44 +02:00
//
// On non-GopherJS environments, Run returns error when 1) OpenGL error happens, 2) audio error happens or
// 3) f returns error. In the case of 3), Run returns the same error.
//
// On GopherJS, Run returns immediately.
2019-01-17 15:40:33 +01:00
// It is because the 'main' goroutine cannot be blocked on GopherJS due to the bug (gopherjs/gopherjs#826).
// When an error happens, this is shown as an error on the console.
2016-07-02 21:13:39 +02:00
//
// The size unit is device-independent pixel.
2017-09-30 18:59:34 +02:00
//
// Don't call Run twice or more in one process.
2016-06-18 19:59:17 +02:00
func Run(f func(*Image) error, width, height int, scale float64, title string) error {
if IsWindowResizable() {
panic("ebiten: a resizable window works with RunGame, not Run")
}
game := &defaultGame{
update: (&imageDumper{f: f}).update,
width: width,
height: height,
}
ww, wh := int(float64(width)*scale), int(float64(height)*scale)
fixWindowPosition(ww, wh)
SetWindowSize(ww, wh)
SetWindowTitle(title)
2019-12-22 09:22:54 +01:00
return runGame(game, scale)
2016-05-06 05:23:48 +02:00
}
type imageDumperGame struct {
game Game
d *imageDumper
}
func (i *imageDumperGame) Update(screen *Image) error {
if i.d == nil {
i.d = &imageDumper{f: i.game.Update}
}
return i.d.update(screen)
}
func (i *imageDumperGame) Layout(outsideWidth, outsideHeight int) (screenWidth, screenHeight int) {
return i.game.Layout(outsideWidth, outsideHeight)
}
// RunGame starts the main loop and runs the game.
// game's Update function is called every frame.
2019-12-22 05:21:15 +01:00
// game's Layout function is called when necessary, and you can specify the logical screen size by the function.
//
// RunGame is a more flexibile form of Run due to 'Layout' function.
2019-12-22 05:21:15 +01:00
// You can make a resizable window if you use RunGame, while you cannot if you use Run.
// RunGame is more sophisticated way than Run and hides the notion of 'scale'.
//
// While Run specifies the window size, RunGame does not.
// You need to call SetWindowSize before RunGame if you want.
// Otherwise, a default window size is adopted.
//
// Some functions (ScreenScale, SetScreenScale, SetScreenSize) are not available with RunGame.
//
// A window size is based on the given values (width, height and scale).
//
// RunGame must be called on the main thread.
// Note that Ebiten bounds the main goroutine to the main OS thread by runtime.LockOSThread.
//
// Ebiten tries to call game's Update function 60 times a second by default. In other words,
// TPS (ticks per second) is 60 by default.
// This is not related to framerate (display's refresh rate).
//
// game's Update is not called when the window is in background by default.
// This setting is configurable with SetRunnableInBackground.
//
// The given scale is ignored on fullscreen mode or gomobile-build mode.
//
// On non-GopherJS environments, RunGame returns error when 1) OpenGL error happens, 2) audio error happens or
// 3) f returns error. In the case of 3), RunGame returns the same error.
//
// On GopherJS, RunGame returns immediately.
// It is because the 'main' goroutine cannot be blocked on GopherJS due to the bug (gopherjs/gopherjs#826).
// When an error happens, this is shown as an error on the console.
//
// The size unit is device-independent pixel.
//
// Don't call RunGame twice or more in one process.
func RunGame(game Game) error {
2019-12-24 16:05:56 +01:00
fixWindowPosition(WindowSize())
return runGame(&imageDumperGame{game: game}, 0)
2019-12-22 09:22:54 +01:00
}
func runGame(game Game, scale float64) error {
theUIContext.set(game, scale)
if err := uiDriver().Run(theUIContext); err != nil {
if err == driver.RegularTermination {
return nil
}
return err
}
return nil
}
// RunGameWithoutMainLoop runs the game, but don't call the loop on the main (UI) thread.
// Different from Run, RunGameWithoutMainLoop returns immediately.
2016-05-18 18:49:57 +02:00
//
// Ebiten users should NOT call RunGameWithoutMainLoop.
2018-03-23 17:07:36 +01:00
// Instead, functions in github.com/hajimehoshi/ebiten/mobile package calls this.
func RunGameWithoutMainLoop(game Game) {
game = &imageDumperGame{game: game}
fixWindowPosition(WindowSize())
theUIContext.set(game, 0)
uiDriver().RunWithoutMainLoop(theUIContext)
2016-05-18 18:49:57 +02:00
}
// ScreenSizeInFullscreen is deprecated as of 1.11.0-alpha.
2020-01-24 03:32:56 +01:00
// Use SetFulllscreen, RunGame and the interface Game's Layout instead.
func ScreenSizeInFullscreen() (int, int) {
return uiDriver().ScreenSizeInFullscreen()
2018-05-04 09:09:55 +02:00
}
// MonitorSize is deprecated as of 1.8.0-alpha.
2020-01-24 03:32:56 +01:00
// Use SetFulllscreen, RunGame and the interface Game's Layout instead.
2018-10-11 03:29:57 +02:00
func MonitorSize() (int, int) {
return ScreenSizeInFullscreen()
}
// SetScreenSize is deprecated as of 1.11.0-alpha. Use SetWindowSize and RunGame (Game's Layout) instead.
2016-03-26 09:50:00 +01:00
func SetScreenSize(width, height int) {
if width <= 0 || height <= 0 {
panic("ebiten: width and height must be positive")
2016-04-10 18:45:13 +02:00
}
theUIContext.setScreenSize(width, height)
2016-03-26 09:50:00 +01:00
}
// SetScreenScale is deprecated as of 1.11.0-alpha. Use SetWindowSize instead.
2016-06-18 19:59:17 +02:00
func SetScreenScale(scale float64) {
if scale <= 0 {
panic("ebiten: scale must be positive")
2016-04-10 18:45:13 +02:00
}
theUIContext.setScaleForWindow(scale)
2015-02-09 16:10:50 +01:00
}
2016-03-22 16:44:16 +01:00
// ScreenScale is deprecated as of 1.11.0-alpha. Use WindowSize instead.
2016-06-18 19:59:17 +02:00
func ScreenScale() float64 {
return theUIContext.getScaleForWindow()
2016-03-22 16:44:16 +01:00
}
2016-09-03 10:17:54 +02:00
// CursorMode returns the current cursor mode.
2017-08-12 08:39:41 +02:00
//
// On browsers, only CursorModeVisible and CursorModeHidden are supported.
2017-08-12 08:39:41 +02:00
//
// CursorMode returns CursorModeHidden on mobiles.
//
// CursorMode is concurrent-safe.
func CursorMode() CursorModeType {
return CursorModeType(uiDriver().CursorMode())
2017-08-12 08:39:41 +02:00
}
// SetCursorMode sets the render and capture mode of the mouse cursor.
// CursorModeVisible sets the cursor to always be visible.
// CursorModeHidden hides the system cursor when over the window.
// CursorModeCaptured hides the system cursor and locks it to the window.
//
// On browsers, only CursorModeVisible and CursorModeHidden are supported.
2016-09-03 10:17:54 +02:00
//
// SetCursorMode does nothing on mobiles.
2017-08-12 08:39:41 +02:00
//
// SetCursorMode is concurrent-safe.
func SetCursorMode(mode CursorModeType) {
uiDriver().SetCursorMode(driver.CursorMode(mode))
}
// IsCursorVisible is deprecated as of 1.11.0-alpha. Use CursorMode instead.
func IsCursorVisible() bool {
return CursorMode() == CursorModeVisible
}
// SetCursorVisible is deprecated as of 1.11.0-alpha. Use SetCursorMode instead.
func SetCursorVisible(visible bool) {
if visible {
SetCursorMode(CursorModeVisible)
} else {
SetCursorMode(CursorModeHidden)
}
}
// SetCursorVisibility is deprecated as of 1.6.0-alpha. Use SetCursorMode instead.
2016-09-03 10:17:54 +02:00
func SetCursorVisibility(visible bool) {
SetCursorVisible(visible)
2016-09-03 10:17:54 +02:00
}
2019-10-21 21:07:14 +02:00
// IsFullscreen reports whether the current mode is fullscreen or not.
2017-07-01 06:07:44 +02:00
//
2019-10-21 21:07:14 +02:00
// IsFullscreen always returns false on browsers.
2019-10-21 21:15:15 +02:00
// IsFullscreen works as this as of 1.10.0-alpha.
2019-10-21 21:07:14 +02:00
// Before that, IsFullscreen reported whether the current mode is fullscreen or not.
//
// IsFullscreen always returns false on mobiles.
2017-09-30 18:59:34 +02:00
//
// IsFullscreen is concurrent-safe.
func IsFullscreen() bool {
return uiDriver().IsFullscreen()
}
// SetFullscreen changes the current mode to fullscreen or not on desktops.
2017-07-01 06:07:44 +02:00
//
// On fullscreen mode, the game screen is automatically enlarged
// to fit with the monitor. The current scale value is ignored.
//
2017-07-21 19:15:09 +02:00
// On desktops, Ebiten uses 'windowed' fullscreen mode, which doesn't change
2017-07-01 06:07:44 +02:00
// your monitor's resolution.
//
2019-10-21 21:07:14 +02:00
// SetFullscreen does nothing on browsers.
2019-10-21 21:15:15 +02:00
// SetFullscreen works as this as of 1.10.0-alpha.
2019-10-21 21:07:14 +02:00
// Before that, SetFullscreen affected the fullscreen mode.
//
// SetFullscreen does nothing on mobiles.
2017-07-21 19:15:09 +02:00
//
// SetFullscreen is concurrent-safe.
func SetFullscreen(fullscreen bool) {
uiDriver().SetFullscreen(fullscreen)
}
// IsForeground returns a boolean value indicating whether
// the game is in focus or in the foreground.
//
// IsForeground will only return true if IsRunnableInBackground is false.
//
// IsForeground is concurrent-safe.
func IsForeground() bool {
return uiDriver().IsForeground()
}
// IsRunnableInBackground returns a boolean value indicating whether
// the game runs even in background.
//
// IsRunnableInBackground is concurrent-safe.
func IsRunnableInBackground() bool {
return uiDriver().IsRunnableInBackground()
}
// SetRunnableInBackground sets the state if the game runs even in background.
//
// If the given value is true, the game runs in background e.g. when losing focus.
// The initial state is false.
//
// Known issue: On browsers, even if the state is on, the game doesn't run in background tabs.
// This is because browsers throttles background tabs not to often update.
//
2017-08-12 08:39:41 +02:00
// SetRunnableInBackground does nothing on mobiles so far.
//
// SetRunnableInBackground is concurrent-safe.
func SetRunnableInBackground(runnableInBackground bool) {
uiDriver().SetRunnableInBackground(runnableInBackground)
}
2017-09-22 21:12:02 +02:00
// DeviceScaleFactor returns a device scale factor value of the current monitor which the window belongs to.
2018-01-03 08:52:41 +01:00
//
// DeviceScaleFactor returns a meaningful value on high-DPI display environment,
// otherwise DeviceScaleFactor returns 1.
2018-01-03 08:52:41 +01:00
//
// DeviceScaleFactor might panic on init function on some devices like Android.
// Then, it is not recommended to call DeviceScaleFactor from init functions.
//
// DeviceScaleFactor must be called on the main thread before the main loop, and is concurrent-safe after the main loop.
func DeviceScaleFactor() float64 {
return uiDriver().DeviceScaleFactor()
2018-01-02 21:25:22 +01:00
}
// IsVsyncEnabled returns a boolean value indicating whether
// the game uses the display's vsync.
//
// IsVsyncEnabled is concurrent-safe.
func IsVsyncEnabled() bool {
return uiDriver().IsVsyncEnabled()
}
// SetVsyncEnabled sets a boolean value indicating whether
// the game uses the display's vsync.
//
// If the given value is true, the game tries to sync the display's refresh rate.
// If false, the game ignores the display's refresh rate.
// The initial value is true.
// By disabling vsync, the game works more efficiently but consumes more CPU.
//
2018-12-03 18:23:25 +01:00
// Note that the state doesn't affect TPS (ticks per second, i.e. how many the run function is
2018-07-15 21:57:15 +02:00
// updated per second).
//
2018-07-15 21:57:15 +02:00
// SetVsyncEnabled does nothing on mobiles so far.
//
// SetVsyncEnabled is concurrent-safe.
func SetVsyncEnabled(enabled bool) {
uiDriver().SetVsyncEnabled(enabled)
}
2018-07-17 15:41:27 +02:00
// MaxTPS returns the current maximum TPS.
//
2018-07-17 15:41:27 +02:00
// MaxTPS is concurrent-safe.
func MaxTPS() int {
return int(atomic.LoadInt32(&currentMaxTPS))
}
2018-07-17 19:11:00 +02:00
// CurrentTPS returns the current TPS (ticks per second),
// that represents how many update function is called in a second.
2018-07-17 19:17:06 +02:00
//
// CurrentTPS is concurrent-safe.
2018-07-17 19:11:00 +02:00
func CurrentTPS() float64 {
return clock.CurrentTPS()
}
// UncappedTPS is a special TPS value that means the game doesn't have limitation on TPS.
2018-07-17 19:11:00 +02:00
const UncappedTPS = clock.UncappedTPS
// SetMaxTPS sets the maximum TPS (ticks per second),
// that represents how many updating function is called per second.
// The initial value is 60.
//
// If tps is UncappedTPS, TPS is uncapped and the game is updated per frame.
// If tps is negative but not UncappedTPS, SetMaxTPS panics.
//
// SetMaxTPS is concurrent-safe.
func SetMaxTPS(tps int) {
if tps < 0 && tps != UncappedTPS {
panic("ebiten: tps must be >= 0 or UncappedTPS")
}
2018-07-17 15:41:27 +02:00
atomic.StoreInt32(&currentMaxTPS, int32(tps))
}
// IsScreenTransparent reports whether the window is transparent.
2020-02-09 13:56:48 +01:00
//
// IsScreenTransparent is concurrent-safe.
func IsScreenTransparent() bool {
return uiDriver().IsScreenTransparent()
}
// SetScreenTransparent sets the state if the window is transparent.
//
// SetScreenTransparent panics if SetScreenTransparent is called after the main loop.
//
// SetScreenTransparent does nothing on mobiles.
2020-02-09 13:56:48 +01:00
//
// SetScreenTransparent is concurrent-safe.
func SetScreenTransparent(transparent bool) {
uiDriver().SetScreenTransparent(transparent)
}