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 # Services to load textures, create subtextures and manage their life-cycle
20 # Abstract gamnit texture
21 abstract class Texture
23 # Prepare a texture located at `path` within the `assets` folder
24 new (path
: Text) do return new GamnitAssetTexture(path
.to_s
)
26 # Root texture of which `self` is derived
27 fun root
: GamnitRootTexture is abstract
29 # Width in pixels of this texture
32 # Height in pixels of this texture
35 # Load this texture, force reloading it if `force`
36 fun load
(force
: nullable Bool) do end
38 # Last error on this texture
39 var error
: nullable Error = null
41 # OpenGL handle to this texture
42 fun gl_texture
: Int do return root
.gl_texture
44 # Prepare a subtexture from this texture
45 fun subtexture
(left
, top
, width
, height
: Numeric): GamnitSubtexture
47 # Setup the subtexture
48 var subtex
= new GamnitSubtexture(root
, self, left
.to_f
, top
.to_f
, width
.to_f
, height
.to_f
)
52 # Offset of the left border on `root` from 0.0 to 1.0
53 fun offset_left
: Float do return 0.0
55 # Offset of the top border on `root` from 0.0 to 1.0
56 fun offset_top
: Float do return 0.0
58 # Offset of the right border on `root` from 0.0 to 1.0
59 fun offset_right
: Float do return 1.0
61 # Offset of the bottom border on `root` from 0.0 to 1.0
62 fun offset_bottom
: Float do return 1.0
65 # Colorful small texture of 2x2 pixels
67 super GamnitRootTexture
71 var pixels
= [0xFFu
8, 0x00u
8, 0x00u
8,
72 0x00u
8, 0xFFu
8, 0x00u
8,
73 0x00u
8, 0x00u
8, 0xFFu
8,
74 0xFFu
8, 0xFFu
8, 0xFFu
8]
76 var cpixels
= new CByteArray.from
(pixels
)
80 load_from_pixels
(cpixels
.native_array
, 2, 2, gl_RGB
)
86 # Texture with its own pixels
87 class GamnitRootTexture
90 redef fun root
do return self
92 # Has this texture been loaded yet?
95 redef var gl_texture
= -1
97 init do all_root_textures
.add
self
99 private fun load_from_pixels
(pixels
: Pointer, width
, height
: Int, format
: GLPixelFormat)
101 var max_texture_size
= glGetIntegerv
(gl_MAX_TEXTURE_SIZE
)
102 if width
> max_texture_size
or height
> max_texture_size
then
103 error
= new Error("Texture {self} width or height is over the GL_MAX_TEXTURE_SIZE of {max_texture_size}")
107 glPixelStorei
(gl_UNPACK_ALIGNEMENT
, 1)
108 var tex
= glGenTextures
(1)[0]
111 glBindTexture
(gl_TEXTURE_2D
, tex
)
112 glTexImage2D
(gl_TEXTURE_2D
, 0, format
, width
, height
, 0, format
, gl_UNSIGNED_BYTE
, pixels
)
114 glHint
(gl_GENERATE_MIPMAP_HINT
, gl_NICEST
)
115 glGenerateMipmap
(gl_TEXTURE_2D
)
118 # Set whether this texture should be pixelated when drawn, otherwise it is interpolated
119 fun pixelated
=(pixelated
: Bool)
121 # TODO this service could be made available in `Texture` when using
122 # the kind of texture wrapper of gles v2 or maybe 3
124 glBindTexture
(gl_TEXTURE_2D
, gl_texture
)
126 var param
= if pixelated
then gl_NEAREST
else gl_LINEAR
127 glTexParameteri
(gl_TEXTURE_2D
, gl_TEXTURE_MIN_FILTER
, param
)
128 glTexParameteri
(gl_TEXTURE_2D
, gl_TEXTURE_MAG_FILTER
, param
)
131 # Has this resource been deleted?
134 # Delete this texture and free all its resources
136 # Use caution with this service as the subtextures may rely on the deleted data.
139 if deleted
or not loaded
then return
145 # Texture loaded from the assets folder
146 class GamnitAssetTexture
147 super GamnitRootTexture
149 # Path to this texture within the `assets` folder
152 redef fun load
(force
)
154 if loaded
and force
!= true then return
161 # Partially load this texture from platform-specific features
163 # This method should fill `width`, `height` and `pixels`.
164 private fun load_from_platform
is abstract
166 redef fun to_s
do return "<{class_name} path:{path}>"
169 # Texture derived from another texture, does not own its pixels
170 class GamnitSubtexture
175 # Parent texture, from which this texture was created
178 # Left border of this texture compared to `parent`
181 # Top border of this texture compared to `parent`
184 private fun set_wh
(width
, height
: Float)
190 redef fun load
(force
) do root
.load
(force
)
192 redef var offset_left
= parent
.offset_left
+ left
/ root
.width
is lazy
193 redef var offset_top
= parent
.offset_top
+ top
/ root
.height
is lazy
194 redef var offset_right
= offset_left
+ width
/ root
.width
is lazy
195 redef var offset_bottom
= offset_top
+ height
/ root
.height
is lazy
199 # All declared root textures
200 var all_root_textures
= new TextureSet
205 super HashSet[Texture]
207 # Load all texture of this set
208 fun load_all
do for t
in self do t
.load