Diff: uVGAIII.h

Revision:

5:8acc50389659

Parent:

4:672a6d537dce

Child:

6:58c02c38e75f

diff -r 672a6d537dce -r 8acc50389659 uVGAIII.h
--- a/uVGAIII.h	Mon Mar 24 19:42:30 2014 +0000
+++ b/uVGAIII.h	Mon Mar 24 19:54:56 2014 +0000
@@ -543,10 +543,28 @@
     void puts(char *s);
 
 // Touch Command
-    void detect_touch_region(int, int, int, int);
-    void touch_get_x(int *);
-    void touch_get_y(int *);
-    void touch_set(char);
+/** Specify a new touch detect region on the screen
+* @param x1 x-coordinate of the top left corner of the region
+* @param y1 y-coordinate of the top left corner of the region
+* @param x2 x-coordinate of the bottom right corner of the region
+* @param y2 y-coordinate of the bottom rigth corner of the region
+*/
+    void detect_touch_region(int x1, int y1, int x2, int y2);
+/** Get X coordinates of the touch
+* @param x X coordinate of the touch
+*/
+    void touch_get_x(int *x);
+/** Get Y coordinates of the touch
+* @param y Y coordinate of the touch
+*/
+    void touch_get_y(int *y);
+/** Set various touch screen related parameters
+* @param mode Mode = 0: enable and initialise touch screen hardware; mode = 1: disable the touch screen; mode = 2: reset the current active region to default which is the full screen area
+*/
+    void touch_set(char mode);
+/** Get the status of the screen
+* @return Status of the screen: 0 = INVALID/NOTOUCH, 1 = PRESS, 2 = RELEASE, 3 = MOVING
+*/
     int touch_status(void);
 
 // Screen Version Data