ebiten/internal/graphicscommand/image.go

260 lines
6.8 KiB
Go
Raw Normal View History

2016-06-11 18:45:40 +02:00
// Copyright 2016 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.
2018-10-28 12:10:05 +01:00
package graphicscommand
2016-06-11 18:45:40 +02:00
import (
"fmt"
"image"
"io"
"sort"
"strconv"
"strings"
"github.com/hajimehoshi/ebiten/v2/internal/debug"
2020-10-03 19:35:13 +02:00
"github.com/hajimehoshi/ebiten/v2/internal/graphics"
"github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver"
2020-10-03 19:35:13 +02:00
"github.com/hajimehoshi/ebiten/v2/internal/png"
2016-06-11 18:45:40 +02:00
)
2017-09-21 18:13:37 +02:00
// Image represents an image that is implemented with OpenGL.
2016-06-11 18:45:40 +02:00
type Image struct {
image graphicsdriver.Image
width int
height int
internalWidth int
internalHeight int
screen bool
// id is an indentifier for the image. This is used only when dummping the information.
//
// This is duplicated with graphicsdriver.Image's ID, but this id is still necessary because this image might not
// have its graphicsdriver.Image.
id int
bufferedWP []*graphicsdriver.WritePixelsArgs
}
var nextID = 1
func genNextID() int {
id := nextID
nextID++
return id
2016-06-11 18:45:40 +02:00
}
// imagesWithBuffers is the set of an image with buffers.
var imagesWithBuffers []*Image
// addImageWithBuffer adds an image to the list of images with unflushed buffers.
func addImageWithBuffer(img *Image) {
imagesWithBuffers = append(imagesWithBuffers, img)
}
// flushImageBuffers flushes all the image buffers and send to the command queue.
// flushImageBuffers should be called before flushing commands.
func flushImageBuffers() {
for i, img := range imagesWithBuffers {
img.flushBufferedWritePixels()
imagesWithBuffers[i] = nil
}
imagesWithBuffers = imagesWithBuffers[:0]
}
// NewImage returns a new image.
//
// Note that the image is not initialized yet.
func NewImage(width, height int, screenFramebuffer bool) *Image {
2016-07-04 17:24:06 +02:00
i := &Image{
width: width,
height: height,
screen: screenFramebuffer,
id: genNextID(),
2016-07-04 17:24:06 +02:00
}
2016-06-11 18:45:40 +02:00
c := &newImageCommand{
result: i,
width: width,
height: height,
screen: screenFramebuffer,
2016-06-11 18:45:40 +02:00
}
theCommandQueue.Enqueue(c)
return i
2016-06-11 18:45:40 +02:00
}
func (i *Image) flushBufferedWritePixels() {
if len(i.bufferedWP) == 0 {
return
}
c := &writePixelsCommand{
dst: i,
args: i.bufferedWP,
}
theCommandQueue.Enqueue(c)
i.bufferedWP = nil
}
func (i *Image) Dispose() {
c := &disposeImageCommand{
target: i,
2016-06-11 18:45:40 +02:00
}
theCommandQueue.Enqueue(c)
2016-06-11 18:45:40 +02:00
}
2019-06-25 16:18:00 +02:00
func (i *Image) InternalSize() (int, int) {
if i.screen {
return i.width, i.height
}
if i.internalWidth == 0 {
i.internalWidth = graphics.InternalImageSize(i.width)
}
if i.internalHeight == 0 {
i.internalHeight = graphics.InternalImageSize(i.height)
}
return i.internalWidth, i.internalHeight
2019-06-25 16:18:00 +02:00
}
// DrawTriangles draws triangles with the given image.
//
// The vertex floats are:
//
2022-08-03 13:48:02 +02:00
// 0: Destination X in pixels
// 1: Destination Y in pixels
// 2: Source X in texels
// 3: Source Y in texels
// 4: Color R [0.0-1.0]
// 5: Color G
// 6: Color B
// 7: Color Y
//
// src and shader are exclusive and only either is non-nil.
//
// The elements that index is in between 2 and 7 are used for the source images.
// The source image is 1) src argument if non-nil, or 2) an image value in the uniform variables if it exists.
// If there are multiple images in the uniform variables, the smallest ID's value is adopted.
//
2020-05-24 09:54:28 +02:00
// If the source image is not specified, i.e., src is nil and there is no image in the uniform variables, the
// elements for the source image are not used.
func (i *Image) DrawTriangles(srcs [graphics.ShaderImageCount]*Image, offsets [graphics.ShaderImageCount - 1][2]float32, vertices []float32, indices []uint16, blend graphicsdriver.Blend, dstRegion, srcRegion graphicsdriver.Region, shader *Shader, uniforms [][]float32, evenOdd bool) {
for _, src := range srcs {
if src == nil {
continue
}
if src.screen {
panic("graphicscommand: the screen image cannot be the rendering source")
}
src.flushBufferedWritePixels()
}
i.flushBufferedWritePixels()
theCommandQueue.EnqueueDrawTrianglesCommand(i, srcs, offsets, vertices, indices, blend, dstRegion, srcRegion, shader, uniforms, evenOdd)
2016-06-11 18:45:40 +02:00
}
// ReadPixels reads the image's pixels.
// ReadPixels returns an error when an error happens in the graphics driver.
func (i *Image) ReadPixels(graphicsDriver graphicsdriver.Graphics, buf []byte, x, y, width, height int) error {
i.flushBufferedWritePixels()
c := &readPixelsCommand{
img: i,
x: x,
y: y,
width: width,
height: height,
result: buf,
2016-06-11 18:45:40 +02:00
}
theCommandQueue.Enqueue(c)
if err := theCommandQueue.Flush(graphicsDriver, false); err != nil {
return err
}
return nil
2016-06-11 18:45:40 +02:00
}
func (i *Image) WritePixels(pixels []byte, x, y, width, height int) {
i.bufferedWP = append(i.bufferedWP, &graphicsdriver.WritePixelsArgs{
Pixels: pixels,
X: x,
Y: y,
Width: width,
Height: height,
})
addImageWithBuffer(i)
2016-06-11 18:45:40 +02:00
}
2016-06-12 16:54:36 +02:00
func (i *Image) IsInvalidated(graphicsDriver graphicsdriver.Graphics) (bool, error) {
if i.screen {
// The screen image might not have a texture, and in this case it is impossible to detect whether
// the image is invalidated or not.
return false, fmt.Errorf("graphicscommand: IsInvalidated cannot be called on the screen image")
}
2018-11-04 11:36:33 +01:00
// i.image can be nil before initializing.
if i.image == nil {
return false, nil
2018-11-04 11:36:33 +01:00
}
c := &isInvalidatedCommand{
image: i,
}
theCommandQueue.Enqueue(c)
if err := theCommandQueue.Flush(graphicsDriver, false); err != nil {
return false, err
}
return c.result, nil
2016-06-12 16:54:36 +02:00
}
func (i *Image) dumpName(path string) string {
return strings.ReplaceAll(path, "*", strconv.Itoa(i.id))
}
// dumpTo dumps the image to the specified writer.
//
// If blackbg is true, any alpha values in the dumped image will be 255.
//
// This is for testing usage.
func (i *Image) dumpTo(w io.Writer, graphicsDriver graphicsdriver.Graphics, blackbg bool, rect image.Rectangle) error {
if i.screen {
return fmt.Errorf("graphicscommand: a screen image cannot be dumped")
}
pix := make([]byte, 4*i.width*i.height)
if err := i.ReadPixels(graphicsDriver, pix, 0, 0, i.width, i.height); err != nil {
return err
}
if blackbg {
for i := 0; i < len(pix)/4; i++ {
pix[4*i+3] = 0xff
}
}
if err := png.Encode(w, (&image.RGBA{
Pix: pix,
Stride: 4 * i.width,
Rect: image.Rect(0, 0, i.width, i.height),
}).SubImage(rect)); err != nil {
return err
}
return nil
}
func LogImagesInfo(images []*Image) {
sort.Slice(images, func(a, b int) bool {
return images[a].id < images[b].id
})
for _, i := range images {
w, h := i.InternalSize()
debug.Logf(" %d: (%d, %d)\n", i.id, w, h)
}
}