// 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 graphicscommand import ( "fmt" "github.com/hajimehoshi/ebiten/internal/affine" "github.com/hajimehoshi/ebiten/internal/driver" "github.com/hajimehoshi/ebiten/internal/graphics" ) var theGraphicsDriver driver.Graphics func SetGraphicsDriver(driver driver.Graphics) { theGraphicsDriver = driver } func NeedsRestoring() bool { return theGraphicsDriver.NeedsRestoring() } // command represents a drawing command. // // A command for drawing that is created when Image functions are called like DrawTriangles, // or Fill. // A command is not immediately executed after created. Instaed, it is queued after created, // and executed only when necessary. type command interface { fmt.Stringer Exec(indexOffset int) error NumVertices() int NumIndices() int AddNumVertices(n int) AddNumIndices(n int) CanMerge(dst, src *Image, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool } // commandQueue is a command queue for drawing commands. type commandQueue struct { // 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). // vertices is never shrunk since re-extending a vertices buffer is heavy. // // TODO: This is a number of float32 values, not a number of vertices. // Rename or fix the program. nvertices int indices []uint16 nindices int tmpNumIndices int nextIndex int err error } // theCommandQueue is the command queue for the current process. var theCommandQueue = &commandQueue{} // 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) } 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 { q.indices[q.nindices+i] = indices[i] + offset } q.nindices += len(indices) } func (q *commandQueue) doEnqueueDrawTrianglesCommand(dst, src *Image, nvertices, nindices int, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address, forceNewCommand bool) { if nindices > graphics.IndicesNum { panic(fmt.Sprintf("graphicscommand: nindices must be <= graphics.IndicesNum but not at doEnqueueDrawTrianglesCommand: nindices: %d, graphics.IndicesNum: %d", nindices, graphics.IndicesNum)) } if !forceNewCommand && 0 < len(q.commands) { if last := q.commands[len(q.commands)-1]; last.CanMerge(dst, src, color, mode, filter, address) { last.AddNumVertices(nvertices) last.AddNumIndices(nindices) return } } c := &drawTrianglesCommand{ dst: dst, src: src, nvertices: nvertices, nindices: nindices, color: color, mode: mode, filter: filter, address: address, } q.commands = append(q.commands, c) } // EnqueueDrawTrianglesCommand enqueues a drawing-image command. func (q *commandQueue) EnqueueDrawTrianglesCommand(dst, src *Image, vertices []float32, indices []uint16, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) { if len(indices) > graphics.IndicesNum { panic(fmt.Sprintf("graphicscommand: len(indices) must be <= graphics.IndicesNum but not at EnqueueDrawTrianglesCommand: len(indices): %d, graphics.IndicesNum: %d", len(indices), graphics.IndicesNum)) } split := false if q.tmpNumIndices+len(indices) > graphics.IndicesNum { q.tmpNumIndices = 0 q.nextIndex = 0 split = true } q.appendVertices(vertices) q.appendIndices(indices, uint16(q.nextIndex)) q.nextIndex += len(vertices) / graphics.VertexFloatNum q.tmpNumIndices += len(indices) // TODO: If dst is the screen, reorder the command to be the last. q.doEnqueueDrawTrianglesCommand(dst, src, len(vertices), len(indices), color, mode, filter, address, split) } // Enqueue enqueues a drawing command other than a draw-triangles command. // // For a draw-triangles command, use EnqueueDrawTrianglesCommand. func (q *commandQueue) Enqueue(command command) { // TODO: If dst is the screen, reorder the command to be the last. q.commands = append(q.commands, command) } // Flush flushes the command queue. func (q *commandQueue) Flush() { if q.err != nil { return } es := q.indices vs := q.vertices if recordLog() { fmt.Println("--") } theGraphicsDriver.Begin() for len(q.commands) > 0 { nv := 0 ne := 0 nc := 0 for _, c := range q.commands { if c.NumIndices() > graphics.IndicesNum { panic(fmt.Sprintf("graphicscommand: c.NumIndices() must be <= graphics.IndicesNum but not at Flush: c.NumIndices(): %d, graphics.IndicesNum: %d", c.NumIndices(), graphics.IndicesNum)) } if ne+c.NumIndices() > graphics.IndicesNum { break } nv += c.NumVertices() ne += c.NumIndices() nc++ } if 0 < ne { theGraphicsDriver.SetVertices(vs[:nv], es[:ne]) es = es[ne:] vs = vs[nv:] } indexOffset := 0 for _, c := range q.commands[:nc] { if err := c.Exec(indexOffset); err != nil { q.err = err return } if recordLog() { fmt.Printf("%s\n", c) } // TODO: indexOffset should be reset if the command type is different // from the previous one. This fix is needed when another drawing command is // introduced than drawTrianglesCommand. indexOffset += c.NumIndices() } if 0 < nc { // Call glFlush to prevent black flicking (especially on Android (#226) and iOS). theGraphicsDriver.Flush() } q.commands = q.commands[nc:] } theGraphicsDriver.End() q.commands = nil q.nvertices = 0 q.nindices = 0 q.tmpNumIndices = 0 q.nextIndex = 0 } // Error returns an OpenGL error for the last command. func Error() error { return theCommandQueue.err } // FlushCommands flushes the command queue. func FlushCommands() { theCommandQueue.Flush() } // drawTrianglesCommand represents a drawing command to draw an image on another image. type drawTrianglesCommand struct { dst *Image src *Image nvertices int nindices int color *affine.ColorM mode graphics.CompositeMode filter graphics.Filter address graphics.Address } func (c *drawTrianglesCommand) String() string { return fmt.Sprintf("draw-triangles: dst: %p <- src: %p, colorm: %v, mode %d, filter: %d, address: %d", c.dst, c.src, c.color, c.mode, c.filter, c.address) } // Exec executes the drawTrianglesCommand. func (c *drawTrianglesCommand) Exec(indexOffset int) error { // TODO: Is it ok not to bind any framebuffer here? if c.nindices == 0 { return nil } c.dst.image.SetAsDestination() c.src.image.SetAsSource() if err := theGraphicsDriver.Draw(c.nindices, indexOffset, c.mode, c.color, c.filter, c.address); err != nil { return err } return nil } func (c *drawTrianglesCommand) NumVertices() int { return c.nvertices } func (c *drawTrianglesCommand) NumIndices() int { return c.nindices } func (c *drawTrianglesCommand) AddNumVertices(n int) { c.nvertices += n } func (c *drawTrianglesCommand) AddNumIndices(n int) { c.nindices += n } // CanMerge returns a boolean value indicating whether the other drawTrianglesCommand can be merged // with the drawTrianglesCommand c. func (c *drawTrianglesCommand) CanMerge(dst, src *Image, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool { if c.dst != dst { return false } if c.src != src { return false } if !c.color.Equals(color) { return false } if c.mode != mode { return false } if c.filter != filter { return false } if c.address != address { return false } return true } // replacePixelsCommand represents a command to replace pixels of an image. type replacePixelsCommand struct { dst *Image pixels []byte x int y int width int height int } func (c *replacePixelsCommand) String() string { return fmt.Sprintf("replace-pixels: dst: %p, x: %d, y: %d, width: %d, height: %d", c.dst, c.x, c.y, c.width, c.height) } // Exec executes the replacePixelsCommand. func (c *replacePixelsCommand) Exec(indexOffset int) error { c.dst.image.ReplacePixels(c.pixels, c.x, c.y, c.width, c.height) return nil } func (c *replacePixelsCommand) NumVertices() int { return 0 } func (c *replacePixelsCommand) NumIndices() int { return 0 } func (c *replacePixelsCommand) AddNumVertices(n int) { } func (c *replacePixelsCommand) AddNumIndices(n int) { } func (c *replacePixelsCommand) CanMerge(dst, src *Image, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool { return false } type copyPixelsCommand struct { dst *Image src *Image } func (c *copyPixelsCommand) String() string { return fmt.Sprintf("copy-pixels: dst: %p <- src: %p", c.dst, c.src) } func (c *copyPixelsCommand) Exec(indexOffset int) error { p, err := c.src.image.Pixels() if err != nil { return err } if c.dst.width < c.src.width || c.dst.height < c.src.height { return fmt.Errorf("graphicscommand: the destination size (%d, %d) must include the source size (%d, %d)", c.dst.width, c.dst.height, c.src.width, c.src.height) } c.dst.image.ReplacePixels(p, 0, 0, c.src.width, c.src.height) return nil } func (c *copyPixelsCommand) NumVertices() int { return 0 } func (c *copyPixelsCommand) NumIndices() int { return 0 } func (c *copyPixelsCommand) AddNumVertices(n int) { } func (c *copyPixelsCommand) AddNumIndices(n int) { } func (c *copyPixelsCommand) CanMerge(dst, src *Image, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool { return false } type pixelsCommand struct { result []byte img *Image } // Exec executes a pixelsCommand. func (c *pixelsCommand) Exec(indexOffset int) error { p, err := c.img.image.Pixels() if err != nil { return err } c.result = p return nil } func (c *pixelsCommand) String() string { return fmt.Sprintf("pixels: img: %p", c.img) } 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, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool { return false } // disposeCommand represents a command to dispose an image. type disposeCommand struct { target *Image } func (c *disposeCommand) String() string { return fmt.Sprintf("dispose: target: %p", c.target) } // Exec executes the disposeCommand. func (c *disposeCommand) Exec(indexOffset int) error { c.target.image.Dispose() return nil } func (c *disposeCommand) NumVertices() int { return 0 } func (c *disposeCommand) NumIndices() int { return 0 } func (c *disposeCommand) AddNumVertices(n int) { } func (c *disposeCommand) AddNumIndices(n int) { } func (c *disposeCommand) CanMerge(dst, src *Image, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool { return false } // newImageCommand represents a command to create an empty image with given width and height. type newImageCommand struct { result *Image width int height int } func (c *newImageCommand) String() string { return fmt.Sprintf("new-image: result: %p, width: %d, height: %d", c.result, c.width, c.height) } // Exec executes a newImageCommand. func (c *newImageCommand) Exec(indexOffset int) error { i, err := theGraphicsDriver.NewImage(c.width, c.height) if err != nil { return err } c.result.image = i return nil } func (c *newImageCommand) NumVertices() int { return 0 } func (c *newImageCommand) NumIndices() int { return 0 } func (c *newImageCommand) AddNumVertices(n int) { } func (c *newImageCommand) AddNumIndices(n int) { } func (c *newImageCommand) CanMerge(dst, src *Image, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool { return false } // newScreenFramebufferImageCommand is a command to create a special image for the screen. type newScreenFramebufferImageCommand struct { result *Image width int height int } func (c *newScreenFramebufferImageCommand) String() string { return fmt.Sprintf("new-screen-framebuffer-image: result: %p, width: %d, height: %d", c.result, c.width, c.height) } // Exec executes a newScreenFramebufferImageCommand. func (c *newScreenFramebufferImageCommand) Exec(indexOffset int) error { var err error c.result.image, err = theGraphicsDriver.NewScreenFramebufferImage(c.width, c.height) return err } func (c *newScreenFramebufferImageCommand) NumVertices() int { return 0 } func (c *newScreenFramebufferImageCommand) NumIndices() int { return 0 } func (c *newScreenFramebufferImageCommand) AddNumVertices(n int) { } func (c *newScreenFramebufferImageCommand) AddNumIndices(n int) { } func (c *newScreenFramebufferImageCommand) CanMerge(dst, src *Image, color *affine.ColorM, mode graphics.CompositeMode, filter graphics.Filter, address graphics.Address) bool { return false } // ResetGraphicsDriverState resets or initializes the current graphics driver state. func ResetGraphicsDriverState() error { return theGraphicsDriver.Reset() }