[Gzz-commits] gzz ./TODO doc/gl/Mipzip.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/gzz
Module name:    gzz
Changes by:     Tuomas J. Lukka <address@hidden>        03/01/18 11:39:44

Modified files:
        .              : TODO 
        doc/gl         : Mipzip.rst 

Log message:
        Mipzip doccing

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/gzz/TODO.diff?tr1=1.523&tr2=1.524&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/gzz/doc/gl/Mipzip.rst.diff?tr1=1.5&tr2=1.6&r1=text&r2=text

Patches:
Index: gzz/TODO
diff -u gzz/TODO:1.523 gzz/TODO:1.524
--- gzz/TODO:1.523      Sat Jan 18 10:18:20 2003
+++ gzz/TODO    Sat Jan 18 11:39:44 2003
@@ -160,6 +160,8 @@
            - rationalize doc directory structure:
                - Gzz_Frontend_View.rst -> doc/frontend/View.rst
                  (i.e. no Gzz_ prefixes, tree structure explicit)
+           - nested classes in javadoc: grep for
+             MipzipLoader.Level 
            - a lot of things, which would be easier to handle with better
               design, so these will be fixed on the second implementation 
               round with more object-oriented design
Index: gzz/doc/gl/Mipzip.rst
diff -u gzz/doc/gl/Mipzip.rst:1.5 gzz/doc/gl/Mipzip.rst:1.6
--- gzz/doc/gl/Mipzip.rst:1.5   Fri Jan 17 03:06:07 2003
+++ gzz/doc/gl/Mipzip.rst       Sat Jan 18 11:39:44 2003
@@ -38,7 +38,13 @@
 we need to separate loading the mipmap level and teximaging
 it.
 
-..  UML:: mipziploader
+The following classes collaborate to provide Mipzip
+functionality. First of all, MipzipLoader has a nested
+class, Level, for representing a mipmap level, and
+uses GL.Texture to store the texture which it loads and 
+unloads.
+
+..  UML:: mipziploaderStruct
 
     jlinkpackage gzz.gfx.gl
 
@@ -50,6 +56,7 @@
            Texture tex
            String texFormat
        assoc compos - multi(n) MipzipLoader.Level
+       assoc compos multi(0..1) - multi(1) GL.Texture
     
     class MipzipLoader.Level
        jlink
@@ -60,6 +67,61 @@
        methods
            void loadData()
            void texImage()
+           void discard()
+
+    class GL.Texture
+       jlink
 
     ---
-    horizontally(80, foo, MipzipLoader, MipzipLoader.Level);
+    MipzipLoader.c = (0,0);
+    horizontally(60, comps, GL.Texture,
+                       MipzipLoader.Level);
+
+    vertically(80, foo, MipzipLoader, comps);
+
+MipzipMemoryConsumer provides a published API
+for requesting the Texture ID and posts
+at the same time requests for consuming memory.
+
+..  UML:: mipziploaderThread
+
+    jlinkpackage gzz.gfx.gl
+
+
+    class MipzipLoader
+       jlink
+       fields
+           File mipzipFile
+           ZipFile openedFile
+           Texture tex
+           String texFormat
+
+    class gzz.mem.MemoryConsumer "interface"
+       jlink
+       methods
+           setReservation(...)
+           ...
+
+    class gzz.mem.MemoryPartitioner
+       use gzz.mem.MemoryConsumer
+
+    class MipzipMemoryConsumer
+       jlink
+       inherit gzz.mem.MemoryConsumer
+       methods
+           GL.Texture getTexture(importance, quality)
+       assoc aggreg - multi(1) MipzipLoader
+
+    dep "request" MipzipMemoryConsumer gzz.mem.MemoryPartitioner
+
+    ---
+    MipzipLoader.c = (0,0);
+
+    horizontally(80, baz, MipzipMemoryConsumer, MipzipLoader);
+    vertically(80, faz, gzz.mem.MemoryConsumer, 
+       MipzipMemoryConsumer);
+
+    horizontally(80, naz, gzz.mem.MemoryConsumer,
+               gzz.mem.MemoryPartitioner);
+
+