ebiten/internal/graphicsdriver/opengl/image.go

// Copyright 2018 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 opengl

import (
	"github.com/hajimehoshi/ebiten/v2/internal/driver"
	"github.com/hajimehoshi/ebiten/v2/internal/graphics"
)

type Image struct {
	id            driver.ImageID
	graphics      *Graphics
	textureNative textureNative
	framebuffer   *framebuffer
	pbo           buffer
	width         int
	height        int
	screen        bool
}

func (i *Image) ID() driver.ImageID {
	return i.id
}

func (i *Image) IsInvalidated() bool {
	return !i.graphics.context.isTexture(i.textureNative)
}

func (i *Image) Dispose() {
	if !i.pbo.equal(*new(buffer)) {
		i.graphics.context.deleteBuffer(i.pbo)
	}
	if i.framebuffer != nil {
		i.framebuffer.delete(&i.graphics.context)
	}
	if !i.textureNative.equal(*new(textureNative)) {
		i.graphics.context.deleteTexture(i.textureNative)
	}

	i.graphics.removeImage(i)
}

func (i *Image) setViewport() error {
	if err := i.ensureFramebuffer(); err != nil {
		return err
	}
	i.graphics.context.setViewport(i.framebuffer)
	return nil
}

func (i *Image) Sync() <-chan struct{} {
	// There is no way to sync the textures data on the system memory and GPU.
	ch := make(chan struct{})
	close(ch)
	return ch
}

func (i *Image) Pixels() ([]byte, error) {
	if err := i.ensureFramebuffer(); err != nil {
		return nil, err
	}

	// PBO is created only when PBO is enabled AND ReplacePixels is called.
	// If PBO is enabled but the buffer doesn't exist, this means either ReplacePixels is not called or
	// different draw calls than ReplacePixels were called.
	if !i.graphics.context.canUsePBO() || i.pbo.equal(*new(buffer)) {
		p := i.graphics.context.framebufferPixels(i.framebuffer, i.width, i.height)
		return p, nil
	}

	p := i.graphics.context.getBufferSubData(i.pbo, i.width, i.height)
	return p, nil
}

func (i *Image) framebufferSize() (int, int) {
	if i.screen {
		// The (default) framebuffer size can't be converted to a power of 2.
		// On browsers, i.width and i.height are used as viewport size and
		// Edge can't treat a bigger viewport than the drawing area (#71).
		return i.width, i.height
	}
	return graphics.InternalImageSize(i.width), graphics.InternalImageSize(i.height)
}

func (i *Image) ensureFramebuffer() error {
	if i.framebuffer != nil {
		return nil
	}

	w, h := i.framebufferSize()
	if i.screen {
		i.framebuffer = newScreenFramebuffer(&i.graphics.context, w, h)
		return nil
	}
	f, err := newFramebufferFromTexture(&i.graphics.context, i.textureNative, w, h)
	if err != nil {
		return err
	}
	i.framebuffer = f
	return nil
}

func (i *Image) ReplacePixels(args []*driver.ReplacePixelsArgs) {
	if i.screen {
		panic("opengl: ReplacePixels cannot be called on the screen, that doesn't have a texture")
	}
	if len(args) == 0 {
		return
	}

	// glFlush is necessary on Android.
	// glTexSubImage2D didn't work without this hack at least on Nexus 5x and NuAns NEO [Reloaded] (#211).
	if i.graphics.drawCalled {
		i.graphics.context.flush()
	}
	i.graphics.drawCalled = false

	w, h := i.width, i.height
	if !i.graphics.context.canUsePBO() {
		i.graphics.context.texSubImage2D(i.textureNative, w, h, args)
		return
	}

	if i.pbo.equal(*new(buffer)) {
		i.pbo = i.graphics.context.newPixelBufferObject(w, h)
		if i.pbo.equal(*new(buffer)) {
			panic("opengl: newPixelBufferObject failed")
		}
		if i.framebuffer != nil {
			i.graphics.context.framebufferPixelsToBuffer(i.framebuffer, i.pbo, i.width, i.height)
		}
	}
	if i.pbo.equal(*new(buffer)) {
		panic("opengl: newPixelBufferObject failed")
	}
	i.graphics.context.replacePixelsWithPBO(i.pbo, i.textureNative, w, h, args)
}