ebiten/run.go

110 lines
3.5 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-05-18 03:59:37 +02:00
"github.com/hajimehoshi/ebiten/internal/loop"
"github.com/hajimehoshi/ebiten/internal/ui"
)
2016-03-26 09:50:00 +01:00
// FPS represents how many times game updating happens in a second.
2016-05-18 16:27:28 +02:00
const FPS = 60
2016-03-26 09:50:00 +01:00
// CurrentFPS returns the current number of frames per second of rendering.
//
2016-04-06 03:57:30 +02:00
// This function is concurrent-safe.
2016-03-26 10:46:07 +01:00
//
2016-03-26 09:50:00 +01:00
// This value represents how many times rendering happens in 1/60 second and
// NOT how many times logical game updating (a passed function to Run) happens.
// Note that logical game updating is assured to happen 60 times in a second
// as long as the screen is active.
func CurrentFPS() float64 {
2016-05-18 03:59:37 +02:00
return loop.CurrentFPS()
2016-03-26 09:50:00 +01:00
}
// IsRunningSlowly returns true if the game is running too slowly to keep 60 FPS of rendering.
// The game screen is not updated when IsRunningSlowly is true.
// It is recommended to skip heavy processing, especially drawing, when IsRunningSlowly is true.
2016-03-26 10:46:07 +01:00
//
2016-04-06 03:57:30 +02:00
// This function is concurrent-safe.
2016-03-26 09:50:00 +01:00
func IsRunningSlowly() bool {
2016-05-18 03:59:37 +02:00
return loop.IsRunningSlowly()
2016-03-26 09:50:00 +01:00
}
// Run runs the game.
// f is a function which is called at every frame.
// The argument (*Image) is the render target that represents the screen.
//
// This function must be called from the main thread.
// Note that ebiten bounds the main goroutine to the main OS thread by runtime.LockOSThread.
//
// The given function f is guaranteed to be called 60 times a second
// even if a rendering frame is skipped.
// f is not called when the screen is not shown.
2016-06-18 19:59:17 +02:00
func Run(f func(*Image) error, width, height int, scale float64, title string) error {
2016-05-06 05:23:48 +02:00
ch := make(chan error)
go func() {
2016-05-18 03:46:23 +02:00
g := newGraphicsContext(f)
2016-05-18 16:27:28 +02:00
ch <- loop.Run(g, width, height, scale, title, FPS)
2016-05-06 05:23:48 +02:00
}()
ui.Main()
2016-05-06 05:23:48 +02:00
return <-ch
}
2016-05-18 18:49:57 +02:00
// RunWithoutMainLoop runs the game, but don't call the loop on the main (UI) thread.
// Different from Run, this function returns immediately.
//
// Typically, Ebiten users don't have to call this directly.
// Instead, functions in github.com/hajimehoshi/ebiten/mobile module call this.
2016-06-18 19:59:17 +02:00
func RunWithoutMainLoop(f func(*Image) error, width, height int, scale float64, title string) <-chan error {
2016-05-18 18:49:57 +02:00
ch := make(chan error)
go func() {
g := newGraphicsContext(f)
if err := loop.Run(g, width, height, scale, title, FPS); err != nil {
ch <- err
}
close(ch)
}()
return ch
2016-05-18 18:49:57 +02:00
}
2016-03-26 09:50:00 +01:00
// SetScreenSize changes the (logical) size of the screen.
// This doesn't affect the current scale of the screen.
2016-03-26 10:46:07 +01:00
//
2016-04-06 03:57:30 +02:00
// This function is concurrent-safe.
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
}
ui.CurrentUI().SetScreenSize(width, height)
2016-03-26 09:50:00 +01:00
}
// SetScreenScale changes the scale of the screen.
2016-03-26 10:46:07 +01:00
//
2016-04-06 03:57:30 +02:00
// This function is concurrent-safe.
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
}
ui.CurrentUI().SetScreenScale(scale)
2015-02-09 16:10:50 +01:00
}
2016-03-22 16:44:16 +01:00
// ScreenScale returns the current screen scale.
2016-03-26 10:46:07 +01:00
//
2016-04-06 03:57:30 +02:00
// This function is concurrent-safe.
2016-06-18 19:59:17 +02:00
func ScreenScale() float64 {
return ui.CurrentUI().ScreenScale()
2016-03-22 16:44:16 +01:00
}