Revision 2:60f6946df58c, committed 2014-03-24

Comitter:

ivygatech

Date:

Mon Mar 24 18:47:43 2014 +0000

Parent:

1:cd4cc4298b2a

Child:

3:908810caba2e

Commit message:

Update documentation

Changed in this revision

--- a/uVGAIII.h	Mon Mar 24 17:38:36 2014 +0000
+++ b/uVGAIII.h	Mon Mar 24 18:47:43 2014 +0000
@@ -231,23 +231,158 @@
     void set_volume(char value);
 
 // Graphics Commands
+/** Set the graphics orientation
+* @param mode LANDSCAPE, LANDSCAPE_R, PORTRAIT, PORTRAIT_R
+*/
     void screen_mode(char mode);
+    
+/**
+*  Set background color of the screen
+* @param color 24 bits in total with the most significant byte representing the red part and the middle byte representing the green part and the least significant byte representing the blue part
+*/
     void background_color(int color);
+/**
+*  Draw a circle
+* @param x x-coordinate of the center
+* @param y y-coordinate of the center
+* @param radius radius of the circle
+* @param color color of the outline of the circle
+*/
     void circle(int x , int y , int radius, int color);
+/**
+*  Draw a filled circle
+* @param x x-coordinate of the center
+* @param y y-coordinate of the center
+* @param radius radius of the circle
+* @param color color of the circle
+*/
     void filled_circle(int x, int y, int radius, int color);
-    void triangle(int, int, int, int, int, int, int);
-    void filled_triangle(int, int, int, int, int, int, int);
-    void line(int, int, int, int, int);
-    void rectangle(int, int, int, int, int);
+/**
+*  Draw a triangle
+* @param x1 x-coordinate of the first vertice
+* @param y1 y-coordinate of the first vertice
+* @param x2 x-coordinate of the second vertice
+* @param y2 y-coordinate of the second vertice
+* @param x3 x-coordinate of the third vertice
+* @param y3 y-coordinate of the third vertice
+* @param color color of the outline of the triangle
+*/
+    void triangle(int x1, int y1, int x2, int y2, int x3, int y3, int color);
+/**
+*  Draw a filled triangle
+* @param x1 x-coordinate of the first vertice
+* @param y1 y-coordinate of the first vertice
+* @param x2 x-coordinate of the second vertice
+* @param y2 y-coordinate of the second vertice
+* @param x3 x-coordinate of the third vertice
+* @param y3 y-coordinate of the third vertice
+* @param color color of the triangle
+*/
+    void filled_triangle(int x1, int y1, int x2, int y2, int x3, int y3, int color);
+/**
+*  Draw a line
+* @param x1 x-coordinate of the first vertice
+* @param y1 y-coordinate of the first vertice
+* @param x2 x-coordinate of the second vertice
+* @param y2 y-coordinate of the second vertice
+* @param color color of the line
+*/
+    void line(int x1, int y1 , int x2, int y2, int color);
+/**
+*  Draw a rectangle
+* @param x1 x-coordinate of the first vertice
+* @param y1 y-coordinate of the first vertice
+* @param x2 x-coordinate of the second vertice
+* @param y2 y-coordinate of the second vertice
+* @param color color of the outline of the rectangle
+*/
+    void rectangle(int x1, int y1 , int x2, int y2, int color);
+/**
+*  Draw a filled rectangle
+* @param x1 x-coordinate of the first vertice
+* @param y1 y-coordinate of the first vertice
+* @param x2 x-coordinate of the second vertice
+* @param y2 y-coordinate of the second vertice
+* @param color color of the rectangle
+*/
     void filled_rectangle(int, int, int, int, int);
-    void ellipse(int, int, int, int, int);
-    void filled_ellipse(int, int, int, int, int);
-    void button(int, int, int, int, int, int, int, int, char *);
-    void panel(int, int, int, int, int, int);
-    void slider(char, int, int, int, int, int, int, int);
-    void put_pixel(int, int, int);
-    int  read_pixel(int, int);
-    void screen_copy(int, int, int, int, int, int);
+/**
+*  Draw a ellipse
+* @param x x-coordinate of the center
+* @param y y-coordinate of the center
+* @param radius_x x-radius of the ellipse
+* @param redius_y y-radius of the ellipse
+* @param color color of the outline of the rectangle
+*/
+    void ellipse(int x, int y , int radius_x, int radius_y, int color);
+/**
+*  Draw a filled ellipse
+* @param x x-coordinate of the center
+* @param y y-coordinate of the center
+* @param radius_x x-radius of the ellipse
+* @param redius_y y-radius of the ellipse
+* @param color color of the rectangle
+*/
+    void filled_ellipse(int x, int y , int radius_x, int radius_y, int color);
+/**
+*  Draw a button
+* @param state appearance of button, 0 = Button depressed; 1 = Button raised
+* @param x x-coordinate of the top left corner of the button
+* @param y y-coordinate of the top left corner of the button
+* @param buttoncolor color of the button
+* @param txtcolor color of the text
+* @param font Specifies the Font ID
+* @param txtWidth Set the width of the text
+* @param txtHeight Set the height of the text
+* @param text Specifies the text string
+*/
+    void button(int state, int x, int y, int buttoncolor, int txtcolor, int font, int txtWidth, int txtHeight, char * text);
+/**
+*  Draw a panel
+* @param state appearance of panel, 0 = recessed; 1 = raised
+* @param x x-coordinate of the top left corner of the button
+* @param y y-coordinate of the top left corner of the button
+* @param Width Set the width of the panel
+* @param Height Set the height of the panel
+* @param color Set the color of the panel
+*/
+    void panel(int state, int x, int y, int Width, int Height, int color);
+/**
+*  Draw a slider
+* @param mode Mode = 0: Slider indented, mode = 1: Slider raised, mode 2: Slider hidden
+* @param x1 x-coordinate of the top left position of the slider
+* @param y1 y-coordinate of the top left position of the slider
+* @param x2 x-coordinate of the bottom right position of the slider
+* @param y2 y-coordinate of the bottom right position of the slider
+* @param color Set the color of slider
+* @param scale Set the full scale range of the slider for the thumb from 0 to n
+* @param value If value positive, sets the relative position of the thumb on the slider bar, else set thumb to ABS position of the negative number
+*/
+    void slider(char mode, int x1, int y1, int x2, int y2, int color, int scale, int value);
+/**
+*  Draw a pixel
+* @param x x-coordinate of the pixel
+* @param y y-coordinate of the pixel
+* @param color Set the color of pixel
+*/
+    void put_pixel(int x, int y, int color);
+/**
+*  Read the color value of the pixel
+* @param x x-coordinate of the pixel
+* @param y y-coordinate of the pixel
+* @return the color value of the pixel
+*/
+    int  read_pixel(int x, int y);
+/**
+*  Copy an area of a screen
+* @param xs x-coordinate of the top left corner of the area to be copied 
+* @param ys y-coordinate of the top left corner of the area to be copied 
+* @param xd x-coordinate of the top left corner of the area to be pasted 
+* @param yd y-coordinate of the top left corner of the area to be pasted
+* @param width Set the width of the copied area
+* @param width Set the height of the copied area
+*/
+    void screen_copy(int xs, int ys , int xd, int yd , int width, int height);
     void clipping(char);
     void set_clipping_win(int, int, int, int);
     void extend_clip_region();
@@ -334,4 +469,5 @@
 #endif // DEBUGMODE
 };
 
-typedef unsigned char BYTE;
\ No newline at end of file
+typedef unsigned char BYTE;
+