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 (
|
2022-08-31 05:22:28 +02:00
|
|
|
"fmt"
|
2019-07-19 16:29:19 +02:00
|
|
|
"image"
|
2022-08-27 05:51:30 +02:00
|
|
|
"io"
|
2021-08-04 18:15:41 +02:00
|
|
|
"sort"
|
2022-08-30 20:10:10 +02:00
|
|
|
"strconv"
|
|
|
|
"strings"
|
2019-07-19 16:29:19 +02:00
|
|
|
|
2021-08-04 18:15:41 +02:00
|
|
|
"github.com/hajimehoshi/ebiten/v2/internal/debug"
|
2020-10-03 19:35:13 +02:00
|
|
|
"github.com/hajimehoshi/ebiten/v2/internal/graphics"
|
2022-02-06 12:41:32 +01:00
|
|
|
"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 {
|
2022-02-06 12:41:32 +01:00
|
|
|
image graphicsdriver.Image
|
2019-09-28 16:03:11 +02:00
|
|
|
width int
|
|
|
|
height int
|
|
|
|
internalWidth int
|
|
|
|
internalHeight int
|
|
|
|
screen bool
|
2020-05-19 16:48:43 +02:00
|
|
|
|
2023-01-28 11:06:38 +01:00
|
|
|
// id is an identifier for the image. This is used only when dumping the information.
|
2020-05-19 16:48:43 +02:00
|
|
|
//
|
2022-02-06 12:41:32 +01:00
|
|
|
// This is duplicated with graphicsdriver.Image's ID, but this id is still necessary because this image might not
|
|
|
|
// have its graphicsdriver.Image.
|
2020-05-19 16:48:43 +02:00
|
|
|
id int
|
2019-07-19 16:18:07 +02:00
|
|
|
|
2023-08-16 16:18:37 +02:00
|
|
|
bufferedWritePixelsArgs []graphicsdriver.PixelsArgs
|
2019-07-19 16:18:07 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
var nextID = 1
|
|
|
|
|
|
|
|
func genNextID() int {
|
|
|
|
id := nextID
|
|
|
|
nextID++
|
|
|
|
return id
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
|
|
|
|
2022-10-16 12:47:00 +02:00
|
|
|
// imagesWithBuffers is the set of an image with buffers.
|
|
|
|
var imagesWithBuffers []*Image
|
2022-10-16 08:16:38 +02:00
|
|
|
|
2022-10-16 12:47:00 +02:00
|
|
|
// addImageWithBuffer adds an image to the list of images with unflushed buffers.
|
|
|
|
func addImageWithBuffer(img *Image) {
|
|
|
|
imagesWithBuffers = append(imagesWithBuffers, img)
|
2022-10-16 08:16:38 +02:00
|
|
|
}
|
|
|
|
|
2022-10-16 12:47:00 +02:00
|
|
|
// 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
|
2022-10-16 08:16:38 +02:00
|
|
|
}
|
2022-10-16 12:47:00 +02:00
|
|
|
imagesWithBuffers = imagesWithBuffers[:0]
|
2022-10-16 08:16:38 +02:00
|
|
|
}
|
|
|
|
|
2018-12-16 14:24:19 +01:00
|
|
|
// NewImage returns a new image.
|
|
|
|
//
|
|
|
|
// Note that the image is not initialized yet.
|
2022-06-06 02:21:11 +02:00
|
|
|
func NewImage(width, height int, screenFramebuffer bool) *Image {
|
2016-07-04 17:24:06 +02:00
|
|
|
i := &Image{
|
2019-09-20 16:59:04 +02:00
|
|
|
width: width,
|
|
|
|
height: height,
|
2022-06-06 02:21:11 +02:00
|
|
|
screen: screenFramebuffer,
|
2019-09-20 16:59:04 +02:00
|
|
|
id: genNextID(),
|
2016-07-04 17:24:06 +02:00
|
|
|
}
|
2016-06-11 18:45:40 +02:00
|
|
|
c := &newImageCommand{
|
2016-06-12 15:44:23 +02:00
|
|
|
result: i,
|
|
|
|
width: width,
|
|
|
|
height: height,
|
2022-06-06 02:21:11 +02:00
|
|
|
screen: screenFramebuffer,
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
2023-07-30 11:47:45 +02:00
|
|
|
currentCommandQueue().Enqueue(c)
|
2017-03-03 15:51:25 +01:00
|
|
|
return i
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
|
|
|
|
2022-10-16 12:47:00 +02:00
|
|
|
func (i *Image) flushBufferedWritePixels() {
|
2023-08-16 16:18:37 +02:00
|
|
|
if len(i.bufferedWritePixelsArgs) == 0 {
|
2022-07-04 04:50:06 +02:00
|
|
|
return
|
2019-11-21 15:42:46 +01:00
|
|
|
}
|
2022-08-07 20:02:12 +02:00
|
|
|
c := &writePixelsCommand{
|
2019-11-21 15:42:46 +01:00
|
|
|
dst: i,
|
2023-08-16 16:18:37 +02:00
|
|
|
args: i.bufferedWritePixelsArgs,
|
2019-11-21 15:42:46 +01:00
|
|
|
}
|
2023-07-30 11:47:45 +02:00
|
|
|
currentCommandQueue().Enqueue(c)
|
2023-08-16 16:18:37 +02:00
|
|
|
|
|
|
|
i.bufferedWritePixelsArgs = nil
|
2019-11-21 15:42:46 +01:00
|
|
|
}
|
|
|
|
|
2017-03-03 15:51:25 +01:00
|
|
|
func (i *Image) Dispose() {
|
2023-08-16 16:18:37 +02:00
|
|
|
i.bufferedWritePixelsArgs = nil
|
2020-05-17 20:45:58 +02:00
|
|
|
c := &disposeImageCommand{
|
2016-06-12 15:44:23 +02:00
|
|
|
target: i,
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
2023-07-30 11:47:45 +02:00
|
|
|
currentCommandQueue().Enqueue(c)
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
|
|
|
|
2019-06-25 16:18:00 +02:00
|
|
|
func (i *Image) InternalSize() (int, int) {
|
2020-08-08 09:01:33 +02:00
|
|
|
if i.screen {
|
|
|
|
return i.width, i.height
|
|
|
|
}
|
2019-09-28 16:03:11 +02:00
|
|
|
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
|
|
|
}
|
|
|
|
|
2019-09-19 18:55:18 +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
|
2020-05-23 19:36:09 +02:00
|
|
|
//
|
|
|
|
// src and shader are exclusive and only either is non-nil.
|
2020-05-24 09:43:08 +02:00
|
|
|
//
|
|
|
|
// 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.
|
2022-12-03 08:11:26 +01:00
|
|
|
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 []uint32, evenOdd bool) {
|
2022-10-02 16:49:07 +02:00
|
|
|
for _, src := range srcs {
|
|
|
|
if src == nil {
|
|
|
|
continue
|
2020-07-17 18:09:58 +02:00
|
|
|
}
|
2022-10-02 16:49:07 +02:00
|
|
|
if src.screen {
|
|
|
|
panic("graphicscommand: the screen image cannot be the rendering source")
|
2020-09-20 22:36:47 +02:00
|
|
|
}
|
2022-10-16 12:47:00 +02:00
|
|
|
src.flushBufferedWritePixels()
|
2020-05-24 19:31:54 +02:00
|
|
|
}
|
2022-10-16 12:47:00 +02:00
|
|
|
i.flushBufferedWritePixels()
|
2020-05-17 20:45:58 +02:00
|
|
|
|
2023-07-30 11:47:45 +02:00
|
|
|
currentCommandQueue().EnqueueDrawTrianglesCommand(i, srcs, offsets, vertices, indices, blend, dstRegion, srcRegion, shader, uniforms, evenOdd)
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
|
|
|
|
2022-02-27 09:41:19 +01:00
|
|
|
// ReadPixels reads the image's pixels.
|
|
|
|
// ReadPixels returns an error when an error happens in the graphics driver.
|
2023-08-16 16:18:37 +02:00
|
|
|
func (i *Image) ReadPixels(graphicsDriver graphicsdriver.Graphics, args []graphicsdriver.PixelsArgs) error {
|
2022-10-16 12:47:00 +02:00
|
|
|
i.flushBufferedWritePixels()
|
2022-08-07 18:46:45 +02:00
|
|
|
c := &readPixelsCommand{
|
2023-08-16 16:18:37 +02:00
|
|
|
img: i,
|
|
|
|
args: args,
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
2023-07-30 11:47:45 +02:00
|
|
|
currentCommandQueue().Enqueue(c)
|
|
|
|
if err := currentCommandQueue().Flush(graphicsDriver, false, nil); err != nil {
|
2022-02-27 09:41:19 +01:00
|
|
|
return err
|
2020-01-18 17:18:56 +01:00
|
|
|
}
|
2022-02-27 09:41:19 +01:00
|
|
|
return nil
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
|
|
|
|
2023-04-27 17:00:51 +02:00
|
|
|
func (i *Image) WritePixels(pixels []byte, region image.Rectangle) {
|
2023-08-16 16:18:37 +02:00
|
|
|
i.bufferedWritePixelsArgs = append(i.bufferedWritePixelsArgs, graphicsdriver.PixelsArgs{
|
2019-11-21 15:42:46 +01:00
|
|
|
Pixels: pixels,
|
2023-04-27 17:00:51 +02:00
|
|
|
Region: region,
|
2019-11-21 15:42:46 +01:00
|
|
|
})
|
2022-10-16 12:47:00 +02:00
|
|
|
addImageWithBuffer(i)
|
2016-06-11 18:45:40 +02:00
|
|
|
}
|
2016-06-12 16:54:36 +02:00
|
|
|
|
2022-09-13 05:15:14 +02:00
|
|
|
func (i *Image) IsInvalidated(graphicsDriver graphicsdriver.Graphics) (bool, error) {
|
2019-05-28 04:26:08 +02:00
|
|
|
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.
|
2022-09-13 05:15:14 +02:00
|
|
|
return false, fmt.Errorf("graphicscommand: IsInvalidated cannot be called on the screen image")
|
2019-05-28 04:26:08 +02:00
|
|
|
}
|
|
|
|
|
2018-11-04 11:36:33 +01:00
|
|
|
// i.image can be nil before initializing.
|
|
|
|
if i.image == nil {
|
2022-09-13 05:15:14 +02:00
|
|
|
return false, nil
|
2018-11-04 11:36:33 +01:00
|
|
|
}
|
2022-09-13 05:15:14 +02:00
|
|
|
|
|
|
|
c := &isInvalidatedCommand{
|
|
|
|
image: i,
|
|
|
|
}
|
2023-07-30 11:47:45 +02:00
|
|
|
currentCommandQueue().Enqueue(c)
|
|
|
|
if err := currentCommandQueue().Flush(graphicsDriver, false, nil); err != nil {
|
2022-09-13 05:15:14 +02:00
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
return c.result, nil
|
2016-06-12 16:54:36 +02:00
|
|
|
}
|
2019-07-19 16:29:19 +02:00
|
|
|
|
2022-08-30 20:10:10 +02:00
|
|
|
func (i *Image) dumpName(path string) string {
|
|
|
|
return strings.ReplaceAll(path, "*", strconv.Itoa(i.id))
|
|
|
|
}
|
|
|
|
|
2022-08-27 05:51:30 +02:00
|
|
|
// dumpTo dumps the image to the specified writer.
|
2019-07-19 16:29:19 +02:00
|
|
|
//
|
2020-02-05 19:03:38 +01:00
|
|
|
// If blackbg is true, any alpha values in the dumped image will be 255.
|
|
|
|
//
|
2019-07-19 16:29:19 +02:00
|
|
|
// This is for testing usage.
|
2022-08-27 05:51:30 +02:00
|
|
|
func (i *Image) dumpTo(w io.Writer, graphicsDriver graphicsdriver.Graphics, blackbg bool, rect image.Rectangle) error {
|
2019-07-21 09:38:16 +02:00
|
|
|
if i.screen {
|
2022-08-31 05:22:28 +02:00
|
|
|
return fmt.Errorf("graphicscommand: a screen image cannot be dumped")
|
2019-07-21 09:38:16 +02:00
|
|
|
}
|
|
|
|
|
2022-02-27 12:11:27 +01:00
|
|
|
pix := make([]byte, 4*i.width*i.height)
|
2023-08-16 16:18:37 +02:00
|
|
|
if err := i.ReadPixels(graphicsDriver, []graphicsdriver.PixelsArgs{
|
|
|
|
{
|
|
|
|
Pixels: pix,
|
|
|
|
Region: image.Rect(0, 0, i.width, i.height),
|
|
|
|
},
|
|
|
|
}); err != nil {
|
2020-01-18 17:18:56 +01:00
|
|
|
return err
|
|
|
|
}
|
2020-02-05 19:03:38 +01:00
|
|
|
|
|
|
|
if blackbg {
|
|
|
|
for i := 0; i < len(pix)/4; i++ {
|
|
|
|
pix[4*i+3] = 0xff
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-08-27 05:51:30 +02:00
|
|
|
if err := png.Encode(w, (&image.RGBA{
|
2020-01-18 17:18:56 +01:00
|
|
|
Pix: pix,
|
2019-07-19 16:29:19 +02:00
|
|
|
Stride: 4 * i.width,
|
|
|
|
Rect: image.Rect(0, 0, i.width, i.height),
|
2021-07-29 09:09:25 +02:00
|
|
|
}).SubImage(rect)); err != nil {
|
2019-07-19 16:29:19 +02:00
|
|
|
return err
|
|
|
|
}
|
2022-08-27 05:51:30 +02:00
|
|
|
|
2019-07-19 16:29:19 +02:00
|
|
|
return nil
|
|
|
|
}
|
2021-08-04 18:15:41 +02:00
|
|
|
|
|
|
|
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)
|
|
|
|
}
|
|
|
|
}
|