Diff: uOLED.h

Revision:

21:87a2227c1ad2

Parent:

20:a07d700164c8

Child:

22:66401b612b1b

--- a/uOLED.h	Tue Dec 21 14:47:35 2010 +0000
+++ b/uOLED.h	Sun Dec 26 18:49:00 2010 +0000
@@ -129,16 +129,24 @@
     */
     bool drawLine(char x1, char y1, char x2, char y2, short red, short green, short blue);
     
-    /** Dunno11
-    * Dunno
+    /** !!ToDo!!
+    * 
     * @param returns something.
     */
     bool drawPolygon(char vertices, char *x, char *y, short color);
-    /** Dunno12
-    * Dunno
-    * @param returns something.
+    
+    /** Draw a rectangle.
+    * 
+    * @param x Top left horizontal start position.
+    * @param y Top left vertical start position.
+    * @param width Bottom right horizontal end position.
+    * @param height Bottom right vertical end position.
+    * @param red Amount of red.
+    * @param green Amount of green.
+    * @param blue Amount of blue.
     */
-    bool drawRectangle(char x, char y, char width, char height, short color);
+    bool drawRectangle(char x, char y, char width, char height, short red, short green, short blue);
+    
     /** Draw text to the screen.
     * 
     * @param column X coordinate for text placement.
@@ -152,7 +160,8 @@
     * SGC.drawText(0, 0, 0, FF, "This is text");
     * @endcode
     */
-    bool drawText(char column, char row, char font, short color, char *text);
+    bool drawText(char column, char row, char font, short red, short green, short blue, char *text);
+    
     /** Draw unformated text to the screen.
     * The manual describes this as "graphics format".
     *
@@ -172,26 +181,50 @@
     * @endcode
     */
     bool drawTextUF(char x, char y, char font, short red, short green, short blue, char width, char height, char *text);
-    /** Dunno13
-    * Dunno
-    * @param returns something.
+    
+    /** Draw a triangle.
+    *
+    * Vertices must be defined counter clockwise.
+    *
+    * @param x1 Vertice 1 X coordinate.
+    * @param y1 Vertice 1 Y coordinate.
+    * @param x2 Vertice 2 X coordinate.
+    * @param y2 Vertice 2 Y coordinate.
+    * @param x3 Vertice 3 X coordinate.
+    * @param y3 Vertice 3 Y coordinate.
+    * @param red Amount of red.
+    * @param blue Amount of blue.
+    * @param green Amount of green.
     */
-    bool drawTriangle(char x1, char y1, char x2, char y2, char x3, char y3, short color);
-    /** Dunno15
-    * Dunno
-    * @param returns something.
+    bool drawTriangle(char x1, char y1, char x2, char y2, char x3, char y3, short red, short green, short blue);
+    
+    /** Clear the screen.
+    * 
+    * Remove everything except the background colour.
+    *
+    * @param returns success or failure.
     */
     bool eraseScreen();
+    
     /** Initialize the screen.  This must be completed before any other communication with the device.
+    *
     * Timing allows for at least 500ms delay for initialization.
+    *
     * @param returns bool indicating success or failure of initialization.
     */
     bool init();
-    /** Dunno16
-    * Dunno
-    * @param returns something.
+    
+    /** Set pen size.
+    * 
+    * Sets if objects should be drawn solid or wire frame.
+    * Does not apply to polygon function.
+    *
+    * @param size Sets solid or wire frame.
+    * - 0x00 = Solid
+    * - 0x01 = Wire frame.
     */
     bool penSize(char size);
+    
     /** Dunno17
     * Dunno
     * @param returns something.