ebiten/internal/graphics/command.go

479 lines
12 KiB
Go
Raw Normal View History

2016-06-02 19:34:34 +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.
package graphics
import (
"fmt"
2016-06-02 19:34:34 +02:00
2017-08-06 13:05:14 +02:00
emath "github.com/hajimehoshi/ebiten/internal/math"
"github.com/hajimehoshi/ebiten/internal/opengl"
2016-06-02 19:34:34 +02:00
)
2017-09-11 20:12:17 +02:00
// command represents a drawing command.
//
// A command for drawing that is created when Image functions are called like DrawImage,
// or Fill.
// A command is not immediately executed after created. Instaed, it is queued after created,
// and executed only when necessary.
2016-06-02 19:34:34 +02:00
type command interface {
Exec(indexOffsetInBytes int) error
NumVertices() int
2018-06-10 10:06:40 +02:00
NumIndices() int
2018-03-18 11:58:32 +01:00
AddNumVertices(n int)
2018-06-10 10:06:40 +02:00
AddNumIndices(n int)
CanMerge(dst, src *Image, mode opengl.CompositeMode, filter Filter) bool
2016-06-02 19:34:34 +02:00
}
2017-09-16 08:49:29 +02:00
// commandQueue is a command queue for drawing commands.
2016-06-02 19:34:34 +02:00
type commandQueue struct {
2017-09-18 18:37:24 +02:00
// commands is a queue of drawing commands.
commands []command
// vertices represents a vertices data in OpenGL's array buffer.
vertices []float32
// nvertices represents the current length of vertices.
// nvertices must <= len(vertices).
2017-09-18 18:37:24 +02:00
// vertices is never shrunk since re-extending a vertices buffer is heavy.
2018-06-10 10:10:11 +02:00
//
// TODO: This is a number of float32 values, not a number of vertices.
// Rename or fix the program.
nvertices int
2018-06-10 10:06:40 +02:00
indices []uint16
nindices int
2018-06-10 10:06:40 +02:00
tmpNumIndices int
nextIndex int
err error
2016-06-02 19:34:34 +02:00
}
2017-09-16 08:49:29 +02:00
// theCommandQueue is the command queue for the current process.
var theCommandQueue = &commandQueue{}
2017-09-18 18:37:24 +02:00
// appendVertices appends vertices to the queue.
func (q *commandQueue) appendVertices(vertices []float32) {
if len(q.vertices) < q.nvertices+len(vertices) {
n := q.nvertices + len(vertices) - len(q.vertices)
q.vertices = append(q.vertices, make([]float32, n)...)
}
copy(q.vertices[q.nvertices:], vertices)
q.nvertices += len(vertices)
2016-06-02 19:34:34 +02:00
}
2018-06-10 10:06:40 +02:00
func (q *commandQueue) appendIndices(indices []uint16, offset uint16) {
if len(q.indices) < q.nindices+len(indices) {
n := q.nindices + len(indices) - len(q.indices)
q.indices = append(q.indices, make([]uint16, n)...)
}
for i := range indices {
2018-06-10 10:06:40 +02:00
q.indices[q.nindices+i] = indices[i] + offset
}
2018-06-10 10:06:40 +02:00
q.nindices += len(indices)
}
func (q *commandQueue) doEnqueueDrawImageCommand(dst, src *Image, nvertices, nindices int, mode opengl.CompositeMode, filter Filter, forceNewCommand bool) {
2018-06-10 10:06:40 +02:00
if nindices > indicesNum {
panic("not implemented for too many indices")
}
if !forceNewCommand && 0 < len(q.commands) {
if last := q.commands[len(q.commands)-1]; last.CanMerge(dst, src, mode, filter) {
last.AddNumVertices(nvertices)
2018-06-10 10:06:40 +02:00
last.AddNumIndices(nindices)
return
}
}
c := &drawImageCommand{
dst: dst,
src: src,
nvertices: nvertices,
2018-06-10 10:06:40 +02:00
nindices: nindices,
mode: mode,
filter: filter,
}
q.commands = append(q.commands, c)
}
2017-09-18 18:37:24 +02:00
// EnqueueDrawImageCommand enqueues a drawing-image command.
func (q *commandQueue) EnqueueDrawImageCommand(dst, src *Image, vertices []float32, indices []uint16, mode opengl.CompositeMode, filter Filter) {
if len(indices) > indicesNum {
panic("not reached")
}
split := false
2018-06-10 10:06:40 +02:00
if q.tmpNumIndices+len(indices) > indicesNum {
q.tmpNumIndices = 0
q.nextIndex = 0
split = true
}
q.appendVertices(vertices)
2018-06-10 10:06:40 +02:00
q.appendIndices(indices, uint16(q.nextIndex))
q.nextIndex += len(vertices) * opengl.Float.SizeInBytes() / VertexSizeInBytes()
2018-06-10 10:06:40 +02:00
q.tmpNumIndices += len(indices)
q.doEnqueueDrawImageCommand(dst, src, len(vertices), len(indices), mode, filter, split)
}
2017-09-19 18:35:56 +02:00
// Enqueue enqueues a drawing command other than a draw-image command.
//
2017-09-21 16:33:27 +02:00
// For a draw-image command, use EnqueueDrawImageCommand.
func (q *commandQueue) Enqueue(command command) {
q.commands = append(q.commands, command)
}
2017-09-19 18:35:56 +02:00
// Flush flushes the command queue.
func (q *commandQueue) Flush() {
if q.err != nil {
return
}
// glViewport must be called at least at every frame on iOS.
opengl.GetContext().ResetViewportSize()
2018-06-10 10:06:40 +02:00
es := q.indices
vs := q.vertices
for len(q.commands) > 0 {
nv := 0
ne := 0
nc := 0
for _, c := range q.commands {
2018-06-10 10:06:40 +02:00
if c.NumIndices() > indicesNum {
panic("not reached")
}
2018-06-10 10:06:40 +02:00
if ne+c.NumIndices() > indicesNum {
break
}
nv += c.NumVertices()
2018-06-10 10:06:40 +02:00
ne += c.NumIndices()
nc++
}
if 0 < ne {
// Note that the vertices passed to BufferSubData is not under GC management
// in opengl package due to unsafe-way.
// See BufferSubData in context_mobile.go.
opengl.GetContext().ElementArrayBufferSubData(es[:ne])
opengl.GetContext().ArrayBufferSubData(vs[:nv])
es = es[ne:]
vs = vs[nv:]
}
indexOffsetInBytes := 0
for _, c := range q.commands[:nc] {
if err := c.Exec(indexOffsetInBytes); err != nil {
q.err = err
return
}
2018-05-27 17:49:16 +02:00
// TODO: indexOffsetInBytes should be reset if the command type is different
// from the previous one. This fix is needed when another drawing command is
// introduced than drawImageCommand.
2018-06-10 10:06:40 +02:00
indexOffsetInBytes += c.NumIndices() * 2 // 2 is uint16 size in bytes
}
if 0 < nc {
// Call glFlush to prevent black flicking (especially on Android (#226) and iOS).
opengl.GetContext().Flush()
}
q.commands = q.commands[nc:]
2016-06-02 19:34:34 +02:00
}
q.commands = nil
q.nvertices = 0
2018-06-10 10:06:40 +02:00
q.nindices = 0
q.tmpNumIndices = 0
q.nextIndex = 0
}
// Error returns an OpenGL error for the last command.
func Error() error {
return theCommandQueue.err
2016-06-02 19:34:34 +02:00
}
2017-09-19 18:35:56 +02:00
// FlushCommands flushes the command queue.
func FlushCommands() {
theCommandQueue.Flush()
2016-06-10 22:48:09 +02:00
}
2017-09-19 18:35:56 +02:00
// drawImageCommand represents a drawing command to draw an image on another image.
2016-06-02 19:34:34 +02:00
type drawImageCommand struct {
dst *Image
src *Image
nvertices int
2018-06-10 10:06:40 +02:00
nindices int
mode opengl.CompositeMode
filter Filter
2016-06-02 19:34:34 +02:00
}
// VertexSizeInBytes returns the size in bytes of one vertex.
func VertexSizeInBytes() int {
return theArrayBufferLayout.totalBytes()
}
2016-10-17 04:16:17 +02:00
2017-09-19 18:35:56 +02:00
// Exec executes the drawImageCommand.
func (c *drawImageCommand) Exec(indexOffsetInBytes int) error {
f, err := c.dst.createFramebufferIfNeeded()
2016-12-14 15:40:43 +01:00
if err != nil {
return err
}
f.setAsViewport()
opengl.GetContext().BlendFunc(c.mode)
2018-06-10 10:06:40 +02:00
if c.nindices == 0 {
return nil
}
proj := f.projectionMatrix()
theOpenGLState.useProgram(proj, c.src.texture.native, c.dst, c.src, c.filter)
2018-06-10 10:06:40 +02:00
opengl.GetContext().DrawElements(opengl.Triangles, c.nindices, indexOffsetInBytes)
// glFlush() might be necessary at least on MacBook Pro (a smilar problem at #419),
// but basically this pass the tests (esp. TestImageTooManyFill).
// As glFlush() causes performance problems, this should be avoided as much as possible.
// Let's wait and see, and file a new issue when this problem is newly found.
return nil
2016-06-02 19:34:34 +02:00
}
func (c *drawImageCommand) NumVertices() int {
return c.nvertices
}
2018-06-10 10:06:40 +02:00
func (c *drawImageCommand) NumIndices() int {
return c.nindices
}
2018-03-18 11:58:32 +01:00
func (c *drawImageCommand) AddNumVertices(n int) {
c.nvertices += n
}
2018-06-10 10:06:40 +02:00
func (c *drawImageCommand) AddNumIndices(n int) {
c.nindices += n
}
2018-03-18 11:58:32 +01:00
// CanMerge returns a boolean value indicating whether the other drawImageCommand can be merged
2017-09-19 18:35:56 +02:00
// with the drawImageCommand c.
func (c *drawImageCommand) CanMerge(dst, src *Image, mode opengl.CompositeMode, filter Filter) bool {
if c.dst != dst {
return false
}
if c.src != src {
return false
}
if c.mode != mode {
return false
}
if c.filter != filter {
return false
}
return true
}
2017-09-19 18:35:56 +02:00
// replacePixelsCommand represents a command to replace pixels of an image.
2016-06-02 19:34:34 +02:00
type replacePixelsCommand struct {
dst *Image
2018-01-28 14:40:36 +01:00
pixels []byte
x int
y int
width int
height int
2016-06-02 19:34:34 +02:00
}
2017-09-19 18:35:56 +02:00
// Exec executes the replacePixelsCommand.
func (c *replacePixelsCommand) Exec(indexOffsetInBytes int) error {
2018-02-28 15:40:43 +01:00
// glFlush is necessary on Android.
// glTexSubImage2D didn't work without this hack at least on Nexus 5x and NuAns NEO [Reloaded] (#211).
opengl.GetContext().Flush()
opengl.GetContext().BindTexture(c.dst.texture.native)
opengl.GetContext().TexSubImage2D(c.pixels, c.x, c.y, c.width, c.height)
2016-06-02 19:34:34 +02:00
return nil
}
2016-06-11 15:52:07 +02:00
func (c *replacePixelsCommand) NumVertices() int {
return 0
}
2018-06-10 10:06:40 +02:00
func (c *replacePixelsCommand) NumIndices() int {
return 0
}
2018-03-18 11:58:32 +01:00
func (c *replacePixelsCommand) AddNumVertices(n int) {
}
2018-06-10 10:06:40 +02:00
func (c *replacePixelsCommand) AddNumIndices(n int) {
}
func (c *replacePixelsCommand) CanMerge(dst, src *Image, mode opengl.CompositeMode, filter Filter) bool {
2018-03-18 11:58:32 +01:00
return false
}
type pixelsCommand struct {
result []byte
img *Image
}
// Exec executes a pixelsCommand.
func (c *pixelsCommand) Exec(indexOffsetInBytes int) error {
f, err := c.img.createFramebufferIfNeeded()
if err != nil {
return err
}
p, err := opengl.GetContext().FramebufferPixels(f.native, c.img.width, c.img.height)
if err != nil {
return err
}
c.result = p
return nil
}
func (c *pixelsCommand) NumVertices() int {
return 0
}
func (c *pixelsCommand) NumIndices() int {
return 0
}
func (c *pixelsCommand) AddNumVertices(n int) {
}
func (c *pixelsCommand) AddNumIndices(n int) {
}
func (c *pixelsCommand) CanMerge(dst, src *Image, mode opengl.CompositeMode, filter Filter) bool {
return false
}
2017-09-19 18:35:56 +02:00
// disposeCommand represents a command to dispose an image.
2016-06-11 15:52:07 +02:00
type disposeCommand struct {
target *Image
2016-06-11 15:52:07 +02:00
}
2017-09-19 18:35:56 +02:00
// Exec executes the disposeCommand.
func (c *disposeCommand) Exec(indexOffsetInBytes int) error {
if c.target.framebuffer != nil &&
c.target.framebuffer.native != opengl.GetContext().ScreenFramebuffer() {
opengl.GetContext().DeleteFramebuffer(c.target.framebuffer.native)
2016-06-11 15:52:07 +02:00
}
if c.target.texture != nil {
opengl.GetContext().DeleteTexture(c.target.texture.native)
2016-06-11 15:52:07 +02:00
}
return nil
}
func (c *disposeCommand) NumVertices() int {
return 0
}
2018-06-10 10:06:40 +02:00
func (c *disposeCommand) NumIndices() int {
return 0
}
2018-03-18 11:58:32 +01:00
func (c *disposeCommand) AddNumVertices(n int) {
}
2018-06-10 10:06:40 +02:00
func (c *disposeCommand) AddNumIndices(n int) {
}
func (c *disposeCommand) CanMerge(dst, src *Image, mode opengl.CompositeMode, filter Filter) bool {
2018-03-18 11:58:32 +01:00
return false
}
2017-09-19 18:35:56 +02:00
// newImageCommand represents a command to create an empty image with given width and height.
type newImageCommand struct {
result *Image
width int
height int
}
func checkSize(width, height int) {
if width < 1 {
panic(fmt.Sprintf("graphics: width (%d) must be equal or more than 1.", width))
}
if height < 1 {
panic(fmt.Sprintf("graphics: height (%d) must be equal or more than 1.", height))
}
m := MaxImageSize()
if width > m {
panic(fmt.Sprintf("graphics: width (%d) must be less than or equal to %d", width, m))
}
if height > m {
panic(fmt.Sprintf("graphics: height (%d) must be less than or equal to %d", height, m))
}
}
2017-09-19 18:35:56 +02:00
// Exec executes a newImageCommand.
func (c *newImageCommand) Exec(indexOffsetInBytes int) error {
2017-08-06 13:05:14 +02:00
w := emath.NextPowerOf2Int(c.width)
h := emath.NextPowerOf2Int(c.height)
checkSize(w, h)
native, err := opengl.GetContext().NewTexture(w, h)
if err != nil {
return err
}
c.result.texture = &texture{
native: native,
}
return nil
}
func (c *newImageCommand) NumVertices() int {
return 0
}
2018-06-10 10:06:40 +02:00
func (c *newImageCommand) NumIndices() int {
return 0
}
2018-03-18 11:58:32 +01:00
func (c *newImageCommand) AddNumVertices(n int) {
}
2018-06-10 10:06:40 +02:00
func (c *newImageCommand) AddNumIndices(n int) {
}
func (c *newImageCommand) CanMerge(dst, src *Image, mode opengl.CompositeMode, filter Filter) bool {
2018-03-18 11:58:32 +01:00
return false
}
2017-09-19 18:35:56 +02:00
// newScreenFramebufferImageCommand is a command to create a special image for the screen.
type newScreenFramebufferImageCommand struct {
result *Image
width int
height int
}
2017-09-19 18:35:56 +02:00
// Exec executes a newScreenFramebufferImageCommand.
func (c *newScreenFramebufferImageCommand) Exec(indexOffsetInBytes int) error {
checkSize(c.width, c.height)
// The (default) framebuffer size can't be converted to a power of 2.
// On browsers, c.width and c.height are used as viewport size and
// Edge can't treat a bigger viewport than the drawing area (#71).
c.result.framebuffer = newScreenFramebuffer(c.width, c.height)
return nil
}
func (c *newScreenFramebufferImageCommand) NumVertices() int {
return 0
}
2018-03-18 11:58:32 +01:00
2018-06-10 10:06:40 +02:00
func (c *newScreenFramebufferImageCommand) NumIndices() int {
return 0
}
2018-03-18 11:58:32 +01:00
func (c *newScreenFramebufferImageCommand) AddNumVertices(n int) {
}
2018-06-10 10:06:40 +02:00
func (c *newScreenFramebufferImageCommand) AddNumIndices(n int) {
}
func (c *newScreenFramebufferImageCommand) CanMerge(dst, src *Image, mode opengl.CompositeMode, filter Filter) bool {
2018-03-18 11:58:32 +01:00
return false
}