Diff: uVGAIII.h

Revision:

3:908810caba2e

Parent:

2:60f6946df58c

Child:

4:672a6d537dce

--- a/uVGAIII.h	Mon Mar 24 18:47:43 2014 +0000
+++ b/uVGAIII.h	Mon Mar 24 19:10:21 2014 +0000
@@ -383,16 +383,62 @@
 * @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);
+/**
+*  Enable or disable the ability for Clipping to be used
+* @param value 0 = Clipping Disabled, 1 = Clipping Enabled
+*/
+    void clipping(char value);
+/**
+*  Specifiy the clipping window region on the screen
+* @param x1 x-coordinate of the top left corner of the clipping window
+* @param y1 y-coordinate of the top left corner of the clipping window
+* @param x2 x-coordinate of the bottom right corner of the clipping window
+* @param y2 y-coordinate of the bottom right corner of the clipping window
+*/
+    void set_clipping_win(int x1, int y1, int x2, int y2);
+/**
+*  Force the clip region to the extent of the last text
+* 
+*/
     void extend_clip_region();
-    void change_color(int, int);
-    void move_origin(int, int);
-    void line_pattern(int);
-    void outline_color(int);
-    void transparency(char);
-    void transparent_color(int);
-    void graphics_parameters(int, int);
+/**
+*  Change all old color pixels to new color within the clipping window area
+* @param oldColor Sample color to be changed within the clipping window
+* @param newColor New color to change all occurrences of old color within the clipping window
+*/
+    void change_color(int oldColor, int newColor);
+/**
+*  Move the origin to a new position
+* @param xpos x-coordinate of the new origin
+* @param ypos y-coordinate of the new origin
+*/
+    void move_origin(int xpos, int ypos);
+/**
+*  Set the line pattern
+* @param pattern Correct value 0 to 65535 = number of bits in the line are turned off to form a pattern
+*/
+    void line_pattern(int pattern);
+/**
+*  Set the outline color for rectangles and circles
+* @param color 24 bits in total of the color value
+*/
+    void outline_color(int color);
+/**
+*  Set whether to enable the transparency
+* @param mode 0 = Transparency OFF, 1 = Transparency ON
+*/
+    void transparency(char mode);
+/**
+*  Set the color to be transparent
+* @param color Color to be set to be transparent
+*/
+    void transparent_color(int color);
+/**
+*  Set graphics parameters
+* @param function 18 = Object Color, 32 = Screen Resolution, 33 = Page Display, 34 = Page Read, 35 = Page Write
+* @param value different values to be applied according to different functions
+*/
+    void graphics_parameters(int function, int value);
 
 // Texts Commands
     void set_font(char);