1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Simple API for 2D games, built around `Sprite` and `App::update`
17 # Client programs should implement `App::update` to execute game logic and
18 # add instances of `Sprite` to `App::sprites` and `App::ui_sprites`.
19 # At each frame, all sprites are drawn to the screen.
21 # This system relies on two cameras `App::world_camera` and `App::ui_camera`.
23 # * `App::world_camera` applies a perspective effect to draw the game world.
24 # This camera is designed to be moved around to see the world as well as to
25 # zoom in and out. It is used to position the sprites in `App::sprites`.
27 # * `App::ui_camera` is a simple orthogonal camera to display UI objects.
28 # This camera should mostly be still, it can still move for chock effects
29 # and the like. It can be used to standardize the size of the UI across
30 # devices. It is used to position the sprites in `App::ui_sprites`.
32 # See the sample game at `contrib/asteronits/` and the basic project template
33 # at `lib/gamnit/examples/template/`.
37 intrude import geometry
::points_and_lines
# For _x, _y and _z
39 import matrix
::projection
40 import more_collections
41 import performance_analysis
44 import gamnit
::cameras_cache
45 import gamnit
::dynamic_resolution
46 import gamnit
::limit_fps
47 import gamnit
::camera_control
49 # Visible 2D entity in the game world or UI
51 # Similar to `gamnit::Actor` which is in 3D.
53 # Each sprite associates a `texture` to the position `center`.
54 # The appearance is modified by `rotation`, `invert_x`,
55 # `scale`, `red`, `green`, `blue` and `alpha`.
56 # These values can be changed at any time and will trigger an update
57 # of the data on the GPU side, having a small performance cost.
59 # For a sprite to be visible, it must be added to either the world `sprites`
60 # or the `ui_sprites`.
61 # However, an instance of `Sprite` can only belong to a single `SpriteSet`
62 # at a time. The final on-screen position depends on the camera associated
66 # # Load texture and create sprite
67 # var texture = new Texture("path/in/assets.png")
68 # var sprite = new Sprite(texture, new Point3d[Float](0.0, 0.0, 0.0))
70 # # Add sprite to the visible game world
71 # app.sprites.add sprite
73 # # Extra configuration of the sprite
74 # sprite.rotation = pi/2.0
77 # # Show only the blue colors
82 # To add a sprite to the UI it can be anchored to screen borders
83 # with `ui_camera.top_left` and the likes.
86 # # Place it a bit off the top left of the screen
87 # var pos = app.ui_camera.top_left.offset(128.0, -128.0, 0)
89 # # Load texture and create sprite
90 # var texture = new Texture("path/in/assets.png")
91 # var sprite = new Sprite(texture, pos)
93 # # Add it to the UI (above world sprites)
94 # app.ui_sprites.add sprite
98 # Texture drawn to screen
99 var texture
: Texture is writable(texture_direct
=)
101 # Texture drawn to screen
102 fun texture
=(value
: Texture)
104 if isset _texture
and value
!= texture
then
106 if value
.root
!= texture
.root
then needs_remap
108 texture_direct
= value
111 # Center position of this sprite in world coordinates
112 var center
: Point3d[Float] is writable(center_direct
=), noautoinit
114 # Center position of this sprite in world coordinates
115 fun center
=(value
: Point3d[Float]) is autoinit
do
116 if isset _center
and value
!= center
then
118 center
.sprites_remove
self
121 value
.sprites_add
self
122 center_direct
= value
125 # Rotation on the Z axis, positive values turn counterclockwise
126 var rotation
= 0.0 is writable(rotation_direct
=)
128 # Rotation on the Z axis, positive values turn counterclockwise
129 fun rotation
=(value
: Float)
131 if isset _rotation
and value
!= rotation
then needs_update
132 rotation_direct
= value
135 # Mirror `texture` horizontally, inverting each pixel on the X axis
136 var invert_x
= false is writable(invert_x_direct
=)
138 # Mirror `texture` horizontally, inverting each pixel on the X axis
139 fun invert_x
=(value
: Bool)
141 if isset _invert_x
and value
!= invert_x
then needs_update
142 invert_x_direct
= value
145 # Scale applied to this sprite
147 # The basic size of `self` depends on the size in pixels of `texture`.
148 var scale
= 1.0 is writable(scale_direct
=)
150 # Scale applied to this sprite
152 # The basic size of `self` depends on the size in pixels of `texture`.
153 fun scale
=(value
: Float)
155 if isset _scale
and value
!= scale
then needs_update
159 # Red tint applied to `texture` on draw
160 fun red
: Float do return tint
[0]
162 # Red tint applied to `texture` on draw
163 fun red
=(value
: Float)
165 if isset _tint
and value
!= red
then needs_update
169 # Green tint applied to `texture` on draw
170 fun green
: Float do return tint
[1]
172 # Green tint applied to `texture` on draw
173 fun green
=(value
: Float)
175 if isset _tint
and value
!= green
then needs_update
179 # Blue tint applied to `texture` on draw
180 fun blue
: Float do return tint
[2]
182 # Blue tint applied to `texture` on draw
183 fun blue
=(value
: Float)
185 if isset _tint
and value
!= blue
then needs_update
189 # Transparency applied to `texture` on draw
190 fun alpha
: Float do return tint
[3]
192 # Transparency applied to `texture` on draw
193 fun alpha
=(value
: Float)
195 if isset _tint
and value
!= alpha
then needs_update
199 # Tint applied to `texture` on draw
201 # Alternative to the accessors `red, green, blue & alpha`.
202 # Changes inside the array do not automatically set `needs_update`.
204 # Require: `tint.length == 4`
205 var tint
: Array[Float] = [1.0, 1.0, 1.0, 1.0] is writable(tint_direct
=)
207 # Tint applied to `texture` on draw, see `tint`
208 fun tint
=(value
: Array[Float])
210 if isset _tint
and value
!= tint
then needs_update
214 # Is this sprite static and added in bulk?
216 # Set to `true` to give a hint to the framework that this sprite won't
217 # change often and that it is added in bulk with other static sprites.
218 # This value can be ignored in the prototyping phase of a game and
219 # added only when better performance are needed.
220 var static
= false is writable(static_direct
=)
222 # Is this sprite static and added in bulk? see `static`
223 fun static
=(value
: Bool)
225 if isset _static
and value
!= static
then needs_remap
226 static_direct
= value
229 # Request an update on the CPU
231 # This is called automatically on modification of any value of `Sprite`.
232 # However, it can still be set manually if a modification can't be
233 # detected or by subclasses.
237 if c
!= null then c
.sprites_to_update
.add
self
240 # Request a resorting of this sprite in its sprite list
242 # Resorting is required when `static` or the root of `texture` changes.
243 # This is called automatically when such changes are detected.
244 # However, it can still be set manually if a modification can't be
245 # detected or by subclasses.
249 if l
!= null then l
.sprites_to_remap
.add
self
252 # Current context to which `self` was sorted
253 private var context
: nullable SpriteContext = null
255 # Current context to which `self` belongs
256 private var sprite_set
: nullable SpriteSet = null
260 # Default graphic program to draw `sprites`
261 private var simple_2d_program
= new Simple2dProgram is lazy
263 # Camera for world `sprites` and `depth::actors` with perspective
265 # By default, the camera is configured to a height of 1080 units
266 # of world coordinates at `z == 0.0`.
267 var world_camera
: EulerCamera is lazy
do
268 var camera
= new EulerCamera(app
.display
.as(not null))
270 # Aim for full HD pixel resolution at level 0
271 camera
.reset_height
1080.0
277 # Camera for `ui_sprites` using an orthogonal view
278 var ui_camera
= new UICamera(app
.display
.as(not null)) is lazy
280 # World sprites drawn as seen by `world_camera`
281 var sprites
: Set[Sprite] = new SpriteSet
283 # UI sprites drawn as seen by `ui_camera`, over world `sprites`
284 var ui_sprites
: Set[Sprite] = new SpriteSet
286 # Main method to refine in clients to update game logic and `sprites`
287 fun update
(dt
: Float) do end
289 # Display `texture` as a splash screen
291 # Load `texture` if needed and resets `ui_camera` to 1080 units on the Y axis.
292 fun show_splash_screen
(texture
: Texture)
296 var splash
= new Sprite(texture
, ui_camera
.center
)
297 ui_sprites
.add splash
299 var display
= display
300 assert display
!= null
301 glClear gl_COLOR_BUFFER_BIT
302 frame_core_ui_sprites display
305 ui_sprites
.remove splash
309 # Support and implementation
311 # Main clock used to count each frame `dt`, lapsed for `update` only
312 private var clock
= new Clock is lazy
314 # Performance clock to for `frame_core_draw` operations
315 private var perf_clock_main
= new Clock
317 # Second performance clock for smaller operations
318 private var perf_clock_sprites
= new Clock is lazy
324 var display
= display
325 assert display
!= null
327 var gl_error
= glGetError
328 assert gl_error
== gl_NO_ERROR
else print_error gl_error
331 var program
= simple_2d_program
332 program
.compile_and_link
334 var gamnit_error
= program
.error
335 assert gamnit_error
== null else print_error gamnit_error
338 gl
.capabilities
.blend
.enable
339 glBlendFunc
(gl_SRC_ALPHA
, gl_ONE_MINUS_SRC_ALPHA
)
342 gl
.capabilities
.depth_test
.enable
343 glDepthFunc gl_LEQUAL
346 # Prepare viewport and background color
347 glViewport
(0, 0, display
.width
, display
.height
)
348 glClearColor
(0.0, 0.0, 0.0, 1.0)
350 gl_error
= glGetError
351 assert gl_error
== gl_NO_ERROR
else print_error gl_error
354 for tex
in all_root_textures
do
356 gamnit_error
= tex
.error
357 if gamnit_error
!= null then print_error gamnit_error
359 glTexParameteri
(gl_TEXTURE_2D
, gl_TEXTURE_MIN_FILTER
, gl_LINEAR
)
360 glTexParameteri
(gl_TEXTURE_2D
, gl_TEXTURE_MAG_FILTER
, gl_LINEAR
)
367 simple_2d_program
.delete
370 var display
= display
371 if display
!= null then display
.close
374 redef fun frame_core
(display
)
376 # Prepare to draw, clear buffers
377 glClear
(gl_COLOR_BUFFER_BIT
| gl_DEPTH_BUFFER_BIT
)
380 var gl_error
= glGetError
381 assert gl_error
== gl_NO_ERROR
else print_error gl_error
383 # Update game logic and set sprites
384 perf_clock_main
.lapse
385 var dt
= clock
.lapse
.to_f
387 sys
.perfs
["gamnit flat update client"].add perf_clock_main
.lapse
389 # Draw and flip screen
390 frame_core_draw display
394 gl_error
= glGetError
395 assert gl_error
== gl_NO_ERROR
else print_error gl_error
398 # Draw the whole screen, all `glDraw...` calls should be executed here
399 protected fun frame_core_draw
(display
: GamnitDisplay)
401 frame_core_dynamic_resolution_before display
403 perf_clock_main
.lapse
404 frame_core_world_sprites display
405 perfs
["gamnit flat world_sprites"].add perf_clock_main
.lapse
407 frame_core_ui_sprites display
408 perfs
["gamnit flat ui_sprites"].add perf_clock_main
.lapse
410 frame_core_dynamic_resolution_after display
413 private fun frame_core_sprites
(display
: GamnitDisplay, sprite_set
: SpriteSet, camera
: Camera)
415 var simple_2d_program
= app
.simple_2d_program
416 simple_2d_program
.use
417 simple_2d_program
.mvp
.uniform camera
.mvp_matrix
423 # Draw world sprites from `sprites`
424 protected fun frame_core_world_sprites
(display
: GamnitDisplay)
426 frame_core_sprites
(display
, sprites
.as(SpriteSet), world_camera
)
429 # Draw UI sprites from `ui_sprites`
430 protected fun frame_core_ui_sprites
(display
: GamnitDisplay)
432 # Reset only the depth buffer
433 glClear gl_DEPTH_BUFFER_BIT
435 frame_core_sprites
(display
, ui_sprites
.as(SpriteSet), ui_camera
)
441 # Vertices coordinates of the base geometry
443 # Defines the default width and height of related sprites.
444 private var vertices
: Array[Float] is lazy
do
447 return [-0.5*w
, 0.5*h
, 0.0,
453 # Coordinates of this texture on the `root` texture, in `[0..1.0]`
454 private var texture_coords
: Array[Float] is lazy
do
457 var b
= offset_bottom
465 # Coordinates of this texture on the `root` texture, inverting the X axis
466 private var texture_coords_invert_x
: Array[Float] is lazy
do
469 var b
= offset_bottom
478 # Graphic program to display simple models with a texture, translation, rotation and scale
479 private class Simple2dProgram
480 super GamnitProgramFromSource
482 redef var vertex_shader_source
= """
483 // Vertex coordinates
484 attribute vec4 coord;
487 attribute vec4 color;
489 // Vertex translation
490 attribute vec4 translation;
493 attribute float scale;
495 // Vertex coordinates on textures
496 attribute vec2 tex_coord;
498 // Model view projection matrix
502 attribute vec4 rotation_row0;
503 attribute vec4 rotation_row1;
504 attribute vec4 rotation_row2;
505 attribute vec4 rotation_row3;
509 return mat4(rotation_row0, rotation_row1, rotation_row2, rotation_row3);
512 // Output to the fragment shader
513 varying vec4 v_color;
514 varying vec2 v_coord;
518 gl_Position = (vec4(coord.xyz * scale, 1.0) * rotation() + translation)* mvp;
522 """ @ glsl_vertex_shader
524 redef var fragment_shader_source
= """
525 precision mediump float;
527 // Does this object use a texture?
528 uniform bool use_texture;
530 // Texture to apply on this object
531 uniform sampler2D texture0;
533 // Input from the vertex shader
534 varying vec4 v_color;
535 varying vec2 v_coord;
540 gl_FragColor = v_color * texture2D(texture0, v_coord);
541 if (gl_FragColor.a <= 0.01) discard;
543 gl_FragColor = v_color;
546 """ @ glsl_fragment_shader
548 # Vertices coordinates
549 var coord
= attributes
["coord"].as(AttributeVec4) is lazy
551 # Should this program use the texture `texture`?
552 var use_texture
= uniforms
["use_texture"].as(UniformBool) is lazy
554 # Visible texture unit
555 var texture
= uniforms
["texture0"].as(UniformSampler2D) is lazy
557 # Coordinates on the textures, per vertex
558 var tex_coord
= attributes
["tex_coord"].as(AttributeVec2) is lazy
560 # Color tint per vertex
561 var color
= attributes
["color"].as(AttributeVec4) is lazy
563 # Translation applied to each vertex
564 var translation
= attributes
["translation"].as(AttributeVec4) is lazy
566 # Rotation matrix, row 0
567 var rotation_row0
= attributes
["rotation_row0"].as(AttributeVec4) is lazy
569 # Rotation matrix, row 1
570 var rotation_row1
= attributes
["rotation_row1"].as(AttributeVec4) is lazy
572 # Rotation matrix, row 2
573 var rotation_row2
= attributes
["rotation_row2"].as(AttributeVec4) is lazy
575 # Rotation matrix, row 3
576 var rotation_row3
= attributes
["rotation_row3"].as(AttributeVec4) is lazy
579 var scale
= attributes
["scale"].as(AttributeFloat) is lazy
581 # Model view projection matrix
582 var mvp
= uniforms
["mvp"].as(UniformMat4) is lazy
585 redef class Point3d[N
]
587 # Associate each point to its sprites
589 private var sprites
: nullable Array[Sprite] = null
591 private fun sprites_add
(sprite
: Sprite)
593 var sprites
= sprites
594 if sprites
== null then
595 sprites
= new Array[Sprite]
596 self.sprites
= sprites
601 private fun sprites_remove
(sprite
: Sprite)
603 var sprites
= sprites
604 assert sprites
!= null
605 sprites
.remove sprite
609 # Notify `sprites` on attribute modification
611 private fun needs_update
613 var sprites
= sprites
614 if sprites
!= null then for s
in sprites
do s
.needs_update
619 if isset _x
and v
!= x
then needs_update
625 if isset _y
and v
!= y
then needs_update
631 if isset _z
and v
!= z
then needs_update
636 # Set of sprites sorting them into different `SpriteContext`
637 private class SpriteSet
638 super HashSet[Sprite]
640 # Map texture then static vs dynamic to a `SpriteContext`
641 var contexts_map
= new HashMap2[RootTexture, Bool, SpriteContext]
643 # Contexts in `contexts_map`
644 var contexts_items
= new Array[SpriteContext]
646 # Sprites needing resorting in `contexts_map`
647 var sprites_to_remap
= new Array[Sprite]
649 # Add a sprite to the appropriate context
650 fun map_sprite
(sprite
: Sprite)
652 assert sprite
.context
== null else print_error
"Sprite {sprite} belongs to another SpriteSet"
654 var texture
= sprite
.texture
.root
655 var context
= contexts_map
[texture
, sprite
.static
]
657 if context
== null then
658 var usage
= if sprite
.static
then gl_STATIC_DRAW
else gl_DYNAMIC_DRAW
659 context
= new SpriteContext(texture
, usage
)
661 contexts_map
[texture
, sprite
.static
] = context
662 contexts_items
.add context
665 context
.sprites
.add sprite
666 context
.sprites_to_update
.add sprite
668 sprite
.context
= context
669 sprite
.sprite_set
= self
672 # Remove a sprite from its context
673 fun unmap_sprite
(sprite
: Sprite)
675 var context
= sprite
.context
676 assert context
!= null
677 context
.sprites
.remove sprite
679 sprite
.context
= null
680 sprite
.sprite_set
= null
683 # Draw all sprites by all contexts
686 for sprite
in sprites_to_remap
do
690 sprites_to_remap
.clear
692 for context
in contexts_items
do context
.draw
697 if contexts_items
.has
(e
.context
) then return
705 if e
isa Sprite then unmap_sprite e
708 redef fun remove_all
(e
)
710 if not has
(e
) then return
716 for sprite
in self do
717 sprite
.context
= null
718 sprite
.sprite_set
= null
721 for c
in contexts_items
do c
.destroy
727 # Context for calls to `glDrawElements`
729 # Each context has only one `texture` and `usage`, but many sprites.
730 private class SpriteContext
733 # Context config and state
735 # Only root texture drawn by this context
736 var texture
: nullable RootTexture
738 # OpenGL ES usage of `buffer_array` and `buffer_element`
739 var usage
: GLBufferUsage
741 # Sprites drawn by this context
742 var sprites
= new GroupedArray[Sprite]
744 # Sprites to update since last `draw`
745 var sprites_to_update
= new Set[Sprite]
747 # Sprites that have been update and for which `needs_update` can be set to false
748 var updated_sprites
= new Array[Sprite]
750 # Buffer size to preallocate at `resize`, multiplied by `sprites.length`
752 # Require: `resize_ratio >= 1.0`
753 var resize_ratio
= 1.2
758 # OpenGL ES buffer name for vertex data
759 var buffer_array
: Int = -1
761 # OpenGL ES buffer name for indices
762 var buffer_element
: Int = -1
764 # Current capacity, in sprites, of `buffer_array` and `buffer_element`
765 var buffer_capacity
= 0
767 # C buffers used to pass the data of a single sprite
768 var local_data_buffer
= new GLfloatArray(float_per_vertex
*4) is lazy
769 var local_indices_buffer
= new CUInt16Array(indices_per_sprite
) is lazy
774 # Number of GL_FLOAT per vertex of `Simple2dProgram`
775 var float_per_vertex
: Int is lazy
do
776 # vec4 translation, vec4 color, vec4 coord,
777 # float scale, vec2 tex_coord, vec4 rotation_row*
782 # Number of bytes per vertex of `Simple2dProgram`
783 var bytes_per_vertex
: Int is lazy
do
784 var fs
= 4 # sizeof(GL_FLOAT)
785 return fs
* float_per_vertex
788 # Number of bytes per sprite
789 var bytes_per_sprite
: Int is lazy
do return bytes_per_vertex
* 4
791 # Number of vertex indices per sprite draw call (2 triangles)
792 var indices_per_sprite
= 6
797 # Allocate `buffer_array` and `buffer_element`
800 var bufs
= glGenBuffers
(2)
801 buffer_array
= bufs
[0]
802 buffer_element
= bufs
[1]
804 var gl_error
= glGetError
805 assert gl_error
== gl_NO_ERROR
else print_error gl_error
808 # Destroy `buffer_array` and `buffer_element`
811 glDeleteBuffers
([buffer_array
, buffer_element
])
812 var gl_error
= glGetError
813 assert gl_error
== gl_NO_ERROR
else print_error gl_error
819 # Resize `buffer_array` and `buffer_element` to fit all `sprites` (and more)
822 app
.perf_clock_sprites
.lapse
824 # Allocate a bit more space
825 var capacity
= (sprites
.capacity
.to_f
* resize_ratio
).to_i
827 var array_bytes
= capacity
* bytes_per_sprite
828 glBindBuffer
(gl_ARRAY_BUFFER
, buffer_array
)
829 assert glIsBuffer
(buffer_array
)
830 glBufferData
(gl_ARRAY_BUFFER
, array_bytes
, new Pointer.nul
, usage
)
831 var gl_error
= glGetError
832 assert gl_error
== gl_NO_ERROR
else print_error gl_error
834 # GL_TRIANGLES 6 vertices * sprite
835 var n_indices
= capacity
* indices_per_sprite
836 var ius
= 2 # sizeof(GL_UNSIGNED_SHORT)
837 var element_bytes
= n_indices
* ius
838 glBindBuffer
(gl_ELEMENT_ARRAY_BUFFER
, buffer_element
)
839 assert glIsBuffer
(buffer_element
)
840 glBufferData
(gl_ELEMENT_ARRAY_BUFFER
, element_bytes
, new Pointer.nul
, usage
)
841 gl_error
= glGetError
842 assert gl_error
== gl_NO_ERROR
else print_error gl_error
844 buffer_capacity
= capacity
846 sys
.perfs
["gamnit flat gpu resize"].add app
.perf_clock_sprites
.lapse
849 # Update GPU data of `sprite`
850 fun update_sprite
(sprite
: Sprite)
852 var sprite_index
= sprites
.index_of
(sprite
)
853 if sprite_index
== -1 then return
857 var data
= local_data_buffer
861 data
[o
+ 0] = sprite
.center
.x
862 data
[o
+ 1] = sprite
.center
.y
863 data
[o
+ 2] = sprite
.center
.z
867 data
[o
+ 4] = sprite
.tint
[0]
868 data
[o
+ 5] = sprite
.tint
[1]
869 data
[o
+ 6] = sprite
.tint
[2]
870 data
[o
+ 7] = sprite
.tint
[3]
873 data
[o
+ 8] = sprite
.scale
876 data
[o
+ 9] = sprite
.texture
.vertices
[v
*3+0]
877 data
[o
+10] = sprite
.texture
.vertices
[v
*3+1]
878 data
[o
+11] = sprite
.texture
.vertices
[v
*3+2]
882 var texture
= texture
883 if texture
!= null then
884 var tc
= if sprite
.invert_x
then
885 sprite
.texture
.texture_coords_invert_x
886 else sprite
.texture
.texture_coords
887 data
[o
+13] = tc
[v
*2+0]
888 data
[o
+14] = tc
[v
*2+1]
893 if sprite
.rotation
== 0.0 then
894 # Cache the matrix at no rotation
895 rot
= once
new Matrix.identity
(4)
897 rot
= new Matrix.rotation
(sprite
.rotation
, 0.0, 0.0, 1.0)
899 data
.fill_from_matrix
(rot
, o
+15)
901 o
+= float_per_vertex
904 glBindBuffer
(gl_ARRAY_BUFFER
, buffer_array
)
905 glBufferSubData
(gl_ARRAY_BUFFER
, sprite_index
*bytes_per_sprite
, bytes_per_sprite
, data
.native_array
)
907 var gl_error
= glGetError
908 assert gl_error
== gl_NO_ERROR
else print_error gl_error
917 var indices
= local_indices_buffer
918 var io
= sprite_index
*4
926 glBindBuffer
(gl_ELEMENT_ARRAY_BUFFER
, buffer_element
)
927 glBufferSubData
(gl_ELEMENT_ARRAY_BUFFER
, sprite_index
*6*2, 6*2, indices
.native_array
)
929 gl_error
= glGetError
930 assert gl_error
== gl_NO_ERROR
else print_error gl_error
935 # Call `resize` and `update_sprite` as needed before actual draw operation.
937 # Require: `app.simple_2d_program` and `mvp` must be bound on the GPU
940 if buffer_array
== -1 then prepare
942 assert buffer_array
> 0 and buffer_element
> 0 else
943 print_error
"Internal error: {self} was destroyed"
947 glBindBuffer
(gl_ARRAY_BUFFER
, buffer_array
)
948 glBindBuffer
(gl_ELEMENT_ARRAY_BUFFER
, buffer_element
)
950 # Resize GPU buffers?
951 if sprites
.capacity
> buffer_capacity
then
952 # Try to defragment first
953 var moved
= sprites
.defragment
955 if sprites
.capacity
> buffer_capacity
then
956 # Defragmentation wasn't enough, grow
959 # We must update everything
960 for s
in sprites
.items
do if s
!= null then sprites_to_update
.add s
962 # Just update the moved sprites
963 for s
in moved
do sprites_to_update
.add s
965 else if sprites
.available
.not_empty
then
966 # Defragment a bit anyway
967 # TODO defrag only when there's time left on a frame
968 var moved
= sprites
.defragment
(1)
969 for s
in moved
do sprites_to_update
.add s
972 # Update GPU sprites data
973 if sprites_to_update
.not_empty
then
974 app
.perf_clock_sprites
.lapse
976 for sprite
in sprites_to_update
do update_sprite
(sprite
)
977 sprites_to_update
.clear
979 sys
.perfs
["gamnit flat gpu update"].add app
.perf_clock_sprites
.lapse
982 # Update uniforms specific to this context
983 var texture
= texture
984 app
.simple_2d_program
.use_texture
.uniform texture
!= null
985 if texture
!= null then
986 glActiveTexture gl_TEXTURE0
987 glBindTexture
(gl_TEXTURE_2D
, texture
.gl_texture
)
988 app
.simple_2d_program
.texture
.uniform
0
990 var gl_error
= glGetError
991 assert gl_error
== gl_NO_ERROR
else print_error gl_error
993 # Configure attributes, in order:
994 # vec4 translation, vec4 color, float scale, vec4 coord, vec2 tex_coord, vec4 rotation_row*
996 var p
= app
.simple_2d_program
997 var sizeof_gl_float
= 4 # sizeof(GL_FLOAT)
999 var size
= 4 # Number of floats
1000 glEnableVertexAttribArray p
.translation
.location
1001 glVertexAttribPointeri
(p
.translation
.location
, size
, gl_FLOAT
, false, bytes_per_vertex
, offset
)
1002 offset
+= size
* sizeof_gl_float
1003 gl_error
= glGetError
1004 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1007 glEnableVertexAttribArray p
.color
.location
1008 glVertexAttribPointeri
(p
.color
.location
, size
, gl_FLOAT
, false, bytes_per_vertex
, offset
)
1009 offset
+= size
* sizeof_gl_float
1010 gl_error
= glGetError
1011 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1014 glEnableVertexAttribArray p
.scale
.location
1015 glVertexAttribPointeri
(p
.scale
.location
, size
, gl_FLOAT
, false, bytes_per_vertex
, offset
)
1016 offset
+= size
* sizeof_gl_float
1017 gl_error
= glGetError
1018 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1021 glEnableVertexAttribArray p
.coord
.location
1022 glVertexAttribPointeri
(p
.coord
.location
, size
, gl_FLOAT
, false, bytes_per_vertex
, offset
)
1023 offset
+= size
* sizeof_gl_float
1024 gl_error
= glGetError
1025 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1028 glEnableVertexAttribArray p
.tex_coord
.location
1029 glVertexAttribPointeri
(p
.tex_coord
.location
, size
, gl_FLOAT
, false, bytes_per_vertex
, offset
)
1030 offset
+= size
* sizeof_gl_float
1031 gl_error
= glGetError
1032 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1035 for r
in [p
.rotation_row0
, p
.rotation_row1
, p
.rotation_row2
, p
.rotation_row3
] do
1037 glEnableVertexAttribArray r
.location
1038 glVertexAttribPointeri
(r
.location
, size
, gl_FLOAT
, false, bytes_per_vertex
, offset
)
1040 offset
+= size
* sizeof_gl_float
1041 gl_error
= glGetError
1042 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1046 for s
in sprites
.starts
, e
in sprites
.ends
do
1048 glDrawElementsi
(gl_TRIANGLES
, l
*indices_per_sprite
, gl_UNSIGNED_SHORT
, 2*s
*indices_per_sprite
)
1049 gl_error
= glGetError
1050 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1054 for attr
in [p
.translation
, p
.color
, p
.scale
, p
.coord
, p
.tex_coord
,
1055 p
.rotation_row0
, p
.rotation_row1
, p
.rotation_row2
, p
.rotation_row3
: Attribute] do
1056 if not attr
.is_active
then continue
1057 glDisableVertexAttribArray
(attr
.location
)
1058 gl_error
= glGetError
1059 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1062 glBindBuffer
(gl_ARRAY_BUFFER
, 0)
1063 glBindBuffer
(gl_ELEMENT_ARRAY_BUFFER
, 0)
1064 gl_error
= glGetError
1065 assert gl_error
== gl_NO_ERROR
else print_error gl_error
1069 # Representation of sprite data on the GPU
1071 # The main purpose of this class is to optimize the use of contiguous
1072 # space in GPU memory. Each contiguous memory block can be drawn in a
1073 # single call. The starts index of each block is kept by `starts,
1074 # and the end + 1 by `ends`.
1076 # The data can be compressed by a call to `defragment`.
1079 # intrude import gamnit::flat
1081 # var array = new GroupedArray[String]
1082 # assert array.to_s == ""
1090 # assert array.to_s == "[a,b,c,d,e,f]"
1091 # assert array.capacity == 6
1094 # assert array.to_s == "[b,c,d,e,f]"
1097 # assert array.to_s == "[c,d,e,f]"
1100 # assert array.to_s == "[c,d,e]"
1103 # assert array.to_s == "[c][e]"
1106 # assert array.to_s == "[A][c][e]"
1109 # assert array.to_s == "[A,B,c][e]"
1112 # assert array.to_s == "[A,B,c]"
1115 # assert array.to_s == "[A,B,c,D]"
1118 # assert array.to_s == "[A,B,c,D,E]"
1119 # assert array.capacity == 6
1120 # assert array.length == 5
1127 # assert array.to_s == ""
1130 # assert array.to_s == "[a]"
1132 private class GroupedArray[E
]
1134 # Memory with actual objects, and null in empty slots
1135 var items
= new Array[nullable E
]
1137 # Number of items in the array
1140 # Number of item slots in the array
1141 fun capacity
: Int do return items
.length
1144 fun index_of
(item
: E
): Int do return items
.index_of
(item
)
1146 # List of available slots
1147 var available
= new MinHeap[Int].default
1149 # Start index of filled chunks
1150 var starts
= new List[Int]
1152 # Index of the spots after filled chunks
1153 var ends
= new List[Int]
1155 # Add `item` to the first available slot
1160 if available
.not_empty
then
1161 # starts & ends can't be empty
1163 var i
= available
.take
1166 if i
== starts
.first
- 1 then
1167 # slot 0 free, 1 taken
1170 # slot 0 and more free
1173 else if starts
.length
>= 2 and ends
.first
+ 1 == starts
[1] then
1178 # at end of first chunk
1185 if ends
.is_empty
then
1191 # Remove the first instance of `item`
1194 var i
= items
.index_of
(item
)
1200 for s
in starts
, e
in ends
do
1201 if s
<= i
and i
< e
then
1207 if starts
.is_empty
then
1212 else if e-1
== i
then
1213 # last item of chunk
1217 # first item of chunk
1221 ends
.insert
(ends
[ii
], ii
+1)
1223 starts
.insert
(i
+1, ii
+1)
1235 # Defragment and compress everything into a single chunks beginning at 0
1237 # Returns the elements that moved as a list.
1240 # intrude import gamnit::flat
1242 # var array = new GroupedArray[String]
1249 # assert array.to_s == "[b][d]"
1251 # var moved = array.defragment
1252 # assert moved.to_s == "[d]"
1253 # assert array.to_s == "[d,b]"
1254 # assert array.length == 2
1255 # assert array.capacity == 2
1259 # assert array.to_s == "[d,b,e,f]"
1261 fun defragment
(max
: nullable Int): Array[E
]
1263 app
.perf_clock_sprites
.lapse
1264 max
= max
or else length
1266 var moved
= new Array[E
]
1267 while max
> 0 and (starts
.length
> 1 or starts
.first
!= 0) do
1268 var i
= ends
.last
- 1
1276 if starts
.length
== 1 and starts
.first
== 0 then
1277 for i
in [length
..capacity
[ do items
.pop
1281 sys
.perfs
["gamnit flat gpu defrag"].add app
.perf_clock_sprites
.lapse
1287 var ss
= new Array[String]
1288 for s
in starts
, e
in ends
do
1291 var item
: nullable Object = items
[i
]
1292 if item
== null then item
= "null"
1294 if i
!= e-1
then ss
.add
","
1302 redef class GLfloatArray
1303 private fun fill_from_matrix
(matrix
: Matrix, dst_offset
: nullable Int)
1305 dst_offset
= dst_offset
or else 0
1306 var mat_len
= matrix
.width
*matrix
.height
1307 assert length
>= mat_len
+ dst_offset
1308 native_array
.fill_from_matrix_native
(matrix
.items
, dst_offset
, mat_len
)
1312 redef class NativeGLfloatArray
1313 private fun fill_from_matrix_native
(matrix
: matrix
::NativeDoubleArray, dst_offset
, len
: Int) `{
1315 for (i = 0; i < len; i ++)
1316 self[i+dst_offset] = (GLfloat)matrix[i];