ebiten/internal/restorable/images.go

304 lines
7.4 KiB
Go
Raw Normal View History

// Copyright 2017 The Ebiten Authors
//
// 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.
package restorable
import (
"image"
2019-07-19 18:42:19 +02:00
"path/filepath"
"github.com/hajimehoshi/ebiten/v2/internal/debug"
2020-10-03 19:35:13 +02:00
"github.com/hajimehoshi/ebiten/v2/internal/driver"
"github.com/hajimehoshi/ebiten/v2/internal/graphicscommand"
)
2019-05-26 12:08:46 +02:00
// forceRestoring reports whether restoring forcely happens or not.
var forceRestoring = false
2019-05-26 12:08:46 +02:00
// NeedsRestoring reports whether restoring process works or not.
func NeedsRestoring() bool {
2019-05-26 12:08:46 +02:00
if forceRestoring {
return true
}
return graphicscommand.NeedsRestoring()
}
2017-09-11 20:12:17 +02:00
// EnableRestoringForTesting forces to enable restoring for testing.
func EnableRestoringForTesting() {
2019-05-26 12:08:46 +02:00
forceRestoring = true
}
2017-09-11 20:12:17 +02:00
// images is a set of Image objects.
type images struct {
images map[*Image]struct{}
shaders map[*Shader]struct{}
lastTarget *Image
contextLost bool
}
2017-09-14 17:24:18 +02:00
// theImages represents the images for the current process.
var theImages = &images{
2020-05-24 17:46:23 +02:00
images: map[*Image]struct{}{},
shaders: map[*Shader]struct{}{},
}
2017-09-14 17:24:18 +02:00
// ResolveStaleImages flushes the queued draw commands and resolves
2017-09-11 20:12:17 +02:00
// all stale images.
2017-09-14 17:24:18 +02:00
//
// ResolveStaleImages is intended to be called at the end of a frame.
func ResolveStaleImages() error {
if debug.IsDebug {
debug.Logf("Internal image sizes:\n")
imgs := make([]*graphicscommand.Image, 0, len(theImages.images))
for i := range theImages.images {
imgs = append(imgs, i.image)
}
graphicscommand.LogImagesInfo(imgs)
}
if err := graphicscommand.FlushCommands(); err != nil {
return err
}
if !NeedsRestoring() {
return nil
}
return theImages.resolveStaleImages()
2017-05-03 17:08:07 +02:00
}
2019-05-26 14:10:25 +02:00
// RestoreIfNeeded restores the images.
2017-09-14 17:24:18 +02:00
//
2018-10-28 12:10:05 +01:00
// Restoring means to make all *graphicscommand.Image objects have their textures and framebuffers.
2019-05-26 14:10:25 +02:00
func RestoreIfNeeded() error {
if !NeedsRestoring() {
2019-05-26 14:10:25 +02:00
return nil
}
if !forceRestoring {
var r bool
if canDetectContextLostExplicitly {
r = theImages.contextLost
} else {
// As isInvalidated() is expensive, call this only for one image.
// This assumes that if there is one image that is invalidated, all images are invalidated.
for img := range theImages.images {
// The screen image might not have a texture. Skip this.
if img.screen {
continue
}
var err error
r, err = img.isInvalidated()
if err != nil {
return err
}
break
}
2019-05-26 14:10:25 +02:00
}
2019-05-26 14:10:25 +02:00
if !r {
return nil
}
}
err := graphicscommand.ResetGraphicsDriverState()
if err == driver.GraphicsNotReady {
return nil
}
if err != nil {
2017-08-06 16:00:24 +02:00
return err
}
return theImages.restore()
2017-05-03 17:08:07 +02:00
}
// DumpImages dumps all the current images to the specified directory.
2019-07-14 21:14:57 +02:00
//
// This is for testing usage.
func DumpImages(dir string) error {
for img := range theImages.images {
if err := img.Dump(filepath.Join(dir, "*.png"), false, image.Rect(0, 0, img.width, img.height)); err != nil {
return err
}
}
return nil
}
2017-09-14 17:24:18 +02:00
// add adds img to the images.
2017-05-03 16:15:18 +02:00
func (i *images) add(img *Image) {
i.images[img] = struct{}{}
}
2020-05-24 17:46:23 +02:00
func (i *images) addShader(shader *Shader) {
i.shaders[shader] = struct{}{}
}
2017-09-14 17:24:18 +02:00
// remove removes img from the images.
2017-05-03 16:24:00 +02:00
func (i *images) remove(img *Image) {
i.makeStaleIfDependingOn(img)
delete(i.images, img)
}
2020-05-24 17:46:23 +02:00
func (i *images) removeShader(shader *Shader) {
i.makeStaleIfDependingOnShader(shader)
2020-05-24 17:46:23 +02:00
delete(i.shaders, shader)
}
2017-09-14 17:24:18 +02:00
// resolveStaleImages resolves stale images.
func (i *images) resolveStaleImages() error {
2017-09-14 17:24:18 +02:00
i.lastTarget = nil
for img := range i.images {
if err := img.resolveStale(); err != nil {
return err
}
}
return nil
}
2017-09-14 17:24:18 +02:00
// makeStaleIfDependingOn makes all the images stale that depend on target.
//
// When target is modified, all images depending on target can't be restored with target.
2017-09-14 17:24:18 +02:00
// makeStaleIfDependingOn is called in such situation.
func (i *images) makeStaleIfDependingOn(target *Image) {
if target == nil {
panic("restorable: target must not be nil at makeStaleIfDependingOn")
}
2017-09-14 17:24:18 +02:00
if i.lastTarget == target {
return
}
2017-09-14 17:24:18 +02:00
i.lastTarget = target
for img := range i.images {
2017-05-03 16:18:35 +02:00
img.makeStaleIfDependingOn(target)
}
}
// makeStaleIfDependingOn makes all the images stale that depend on shader.
func (i *images) makeStaleIfDependingOnShader(shader *Shader) {
if shader == nil {
panic("restorable: shader must not be nil at makeStaleIfDependingOnShader")
}
for img := range i.images {
img.makeStaleIfDependingOnShader(shader)
}
}
2017-09-14 17:24:18 +02:00
// restore restores the images.
//
2018-10-28 12:10:05 +01:00
// Restoring means to make all *graphicscommand.Image objects have their textures and framebuffers.
func (i *images) restore() error {
if !NeedsRestoring() {
2019-02-07 09:19:24 +01:00
panic("restorable: restore cannot be called when restoring is disabled")
}
2017-09-14 17:24:18 +02:00
2020-05-24 17:46:23 +02:00
// Dispose all the shaders ahead of restoring. A current shader ID and a new shader ID can be duplicated.
for s := range i.shaders {
if needsDisposingWhenRestoring {
s.shader.Dispose()
}
2020-05-24 17:46:23 +02:00
s.shader = nil
}
for s := range i.shaders {
s.restore()
}
// Dispose all the images ahead of restoring. A current texture ID and a new texture ID can be duplicated.
// TODO: Write a test to confirm that ID duplication never happens.
for i := range i.images {
if needsDisposingWhenRestoring {
i.image.Dispose()
}
i.image = nil
}
// Let's do topological sort based on dependencies of drawing history.
2017-09-14 17:24:18 +02:00
// It is assured that there are not loops since cyclic drawing makes images stale.
type edge struct {
source *Image
target *Image
}
images := map[*Image]struct{}{}
for i := range i.images {
if !i.priority {
images[i] = struct{}{}
}
}
edges := map[edge]struct{}{}
for t := range images {
for s := range t.dependingImages() {
edges[edge{source: s, target: t}] = struct{}{}
}
}
sorted := []*Image{}
for i := range i.images {
if i.priority {
sorted = append(sorted, i)
}
}
for len(images) > 0 {
// current repesents images that have no incoming edges.
current := map[*Image]struct{}{}
for i := range images {
current[i] = struct{}{}
}
for e := range edges {
if _, ok := current[e.target]; ok {
delete(current, e.target)
}
}
for i := range current {
delete(images, i)
sorted = append(sorted, i)
}
removed := []edge{}
for e := range edges {
if _, ok := current[e.source]; ok {
removed = append(removed, e)
}
}
for _, e := range removed {
delete(edges, e)
}
}
for _, img := range sorted {
if err := img.restore(); err != nil {
return err
}
}
i.contextLost = false
return nil
}
var graphicsDriverInitialized bool
// InitializeGraphicsDriverState initializes the graphics driver state.
func InitializeGraphicsDriverState() error {
graphicsDriverInitialized = true
return graphicscommand.InitializeGraphicsDriverState()
}
// MaxImageSize returns the maximum size of an image.
func MaxImageSize() int {
return graphicscommand.MaxImageSize()
}
// OnContextLost is called when the context lost is detected in an explicit way.
func OnContextLost() {
if !canDetectContextLostExplicitly {
panic("restorable: OnContextLost cannot be called in this environment")
}
theImages.contextLost = true
}