rendering: docs and wibbles for release

gloss-rendering/Graphics/Gloss/Internals/Data/Picture.hs

@@ -95,9 +95,13 @@ data Picture
         --   bitmap data.
         --
         --  The boolean flag controls whether Gloss should cache the data
-        --  between frames for speed. If you are programatically generating
-        --  the image for each frame then use `False`. If you have loaded it
-        --  from a file then use `True`.
+        --  in GPU memory between frames. If you are programatically generating
+        --  the image for each frame then use @False@. If you have loaded it
+        --  from a file then use @True@. 
+        --  Setting @False@ for static images will make rendering slower
+        --  than it needs to be.
+        --  Setting @True@  for dynamically generated images will cause a
+        --  GPU memory leak.
         | Bitmap        Int     Int     BitmapData Bool
 
         -- Color ------------------------------------------

gloss-rendering/Graphics/Gloss/Internals/Rendering/Picture.hs

@@ -167,6 +167,7 @@ drawPicture state circScale picture
                       case rowOrder (bitmapFormat imgData) of
                          BottomToTop -> [(0,0), (1,0), (1,1), (0,1)]
                          TopToBottom -> [(0,1), (1,1), (1,0), (0,0)]
+
                 -- Load the image data into a texture,
                 -- or grab it from the cache if we've already done that before.
                 tex     <- loadTexture (stateTextures state) width height imgData cacheMe
@@ -328,7 +329,7 @@ installTexture width height bitmapData@(BitmapData _ fmt fptr) cacheMe
 
 
 -- | If this texture does not have its `cacheMe` flag set then delete it from 
---   OpenGL and free the memory.
+--   OpenGL and free the GPU memory.
 freeTexture :: Texture -> IO ()
 freeTexture tex
  | texCacheMe tex       = return ()

gloss-rendering/Graphics/Gloss/Internals/Rendering/State.hs

@@ -14,7 +14,8 @@ import Data.IORef
 import qualified Graphics.Rendering.OpenGL.GL   as GL
 
 
--- | Render options settings
+-- | Abstract Gloss render state which holds references to textures
+--   loaded into the GPU context.
 data State
         = State
         { -- | Whether to use color

gloss-rendering/gloss-rendering.cabal

@@ -1,5 +1,5 @@
 name:           gloss-rendering
-version:        1.10
+version:        1.10.1.1
 license:        MIT
 license-file:   LICENSE
 author:         Elise Huard