Diff: SlideShow/Renderer.h

Revision:

15:a68bb30ab95e

Parent:

14:647b1896ed84

--- a/SlideShow/Renderer.h	Mon Mar 09 10:50:17 2015 +0100
+++ b/SlideShow/Renderer.h	Mon Mar 09 11:08:43 2015 +0100
@@ -35,7 +35,7 @@
     Renderer();
     ~Renderer();
 
-    /** Specifies a part of a layer
+    /** Registers a part of the screen on a specific layer to be in use.
      *
      *  Returns a handle to pass when updating the framebuffer.
      *
@@ -50,26 +50,35 @@
      *       0 on failure
      */
     uint32_t registerUser(int layer, int xoff, int yoff, int width, int height);
+
+    /** Registers the entire screen on a specific layer to be in use.
+     *
+     *  Returns a handle to pass when updating the framebuffer.
+     *
+     *  @param layer  0 is the bottom of the stack, higher number is on top
+     *
+     *  @returns
+     *       handle to pass to setFrameBuffer function
+     *       0 on failure
+     */
     uint32_t registerFullscreenUser(int layer);
 
-    /** Removes the item from the renderer
+    /** Removes a previously registered user
      *
-     *  @param handle the handle returned in the registerUser() call
+     *  @param handle the handle from the registerUser() call
      */
     void unregisterUser(uint32_t handle);
 
-    /** Informs the renderer that there is new data to use
+    /** Informs the renderer that there is new data to render
      *
-     * Blocks until the data has been register. After that point the
-     * data must not be modified until another call to setFramebuffer.
+     * Blocks until the data has been registered. After that point the
+     * data must not be modified until next call to setFramebuffer.
      *
-     *  @param handle the handle returned in the registerUser() call
+     *  @param handle the handle from the registerUser() call
      *  @param data   the image data
      */
     void setFramebuffer(uint32_t handle, const uint16_t* data);
 
-    void setRenderThread(Thread* renderThread) { t = renderThread; }
-
     /** Run the renderer
      *
      * Should be called from a high priority thread.
@@ -106,7 +115,7 @@
 
     int numRegisteredLayers;
 
-    Thread* t;
+    osThreadId threadId;
     Mutex setupMutex;
 
     int screenWidth;