geometry: make `BoxedArray` a subclass of `Array`

[nit.git] / lib / gamnit / textures.nit

diff --git a/lib/gamnit/textures.nit b/lib/gamnit/textures.nit
index 9b980fb..6b47788 100644 (file)
--- a/lib/gamnit/textures.nit
+++ b/lib/gamnit/textures.nit
@@ -12,19 +12,55 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Services to load textures, create subtextures and manage their life-cycle
+# Load textures, create subtextures and manage their life-cycle
 module textures
 
 import display
 
-# Abstract gamnit texture
+# Texture composed of pixels, loaded from the assets folder by default
+#
+# Most textures should be created with `App` (as attributes)
+# for the method `on_create` to load them.
+#
+# ~~~
+# import gamnit::flat
+#
+# redef class App
+#     # Create the texture object, it will be loaded automatically
+#     var texture = new Texture("path/in/assets.png")
+#
+#     redef fun on_create()
+#     do
+#         # Let `on_create` load the texture
+#         super
+#
+#         # Use the texture
+#         var sprite = new Sprite(texture, new Point3d[Float](0.0, 0.0, 0.0))
+#         app.sprites.add sprite
+#     end
+# end
+# ~~~
+#
+# Otherwise, they can be loaded and error checked explicitly after `on_create`.
+#
+# ~~~nitish
+# var texture = new Texture("path/in/assets.png")
+# texture.load
+# var error = texture.error
+# if error != null then print_error error
+# ~~~
+#
+# A texture may also be created programmatically, like `CheckerTexture`,
+# or derived from another texture, using `subtexture`.
+# Textures with actual pixel data (not `Subtexture`) are `RootTexture`.
+# Texture loaded from the assets folder may in the PNG or JPG formats.
 abstract class Texture
 
        # Prepare a texture located at `path` within the `assets` folder
        new (path: Text) do return new TextureAsset(path.to_s)
 
-       # Root texture of which `self` is derived
-       fun root: GamnitRootTexture is abstract
+       # Root texture from which `self` is derived
+       fun root: RootTexture is abstract
 
        # Width in pixels of this texture
        var width = 0.0
@@ -42,10 +78,10 @@ abstract class Texture
        fun gl_texture: Int do return root.gl_texture
 
        # Prepare a subtexture from this texture, from the given pixel offsets
-       fun subtexture(left, top, width, height: Numeric): GamnitSubtexture
+       fun subtexture(left, top, width, height: Numeric): Subtexture
        do
                # Setup the subtexture
-               var subtex = new GamnitSubtexture(root, self, left.to_f, top.to_f, width.to_f, height.to_f)
+               var subtex = new Subtexture(root, self, left.to_f, top.to_f, width.to_f, height.to_f)
                return subtex
        end
 
@@ -64,7 +100,7 @@ end
 
 # Colorful small texture of 2x2 pixels
 class CheckerTexture
-       super GamnitRootTexture
+       super RootTexture
 
        redef fun load(force)
        do
@@ -84,7 +120,7 @@ class CheckerTexture
 end
 
 # Texture with its own pixels
-class GamnitRootTexture
+class RootTexture
        super Texture
 
        redef fun root do return self
@@ -143,7 +179,7 @@ end
 
 # Texture loaded from the assets folder
 class TextureAsset
-       super GamnitRootTexture
+       super RootTexture
 
        # Path to this texture within the `assets` folder
        var path: String
@@ -166,7 +202,7 @@ class TextureAsset
 end
 
 # Texture derived from another texture, does not own its pixels
-class GamnitSubtexture
+class Subtexture
        super Texture
 
        redef var root