Revision 4:672a6d537dce, committed 2014-03-24

Comitter:

ivygatech

Date:

Mon Mar 24 19:42:30 2014 +0000

Parent:

3:908810caba2e

Child:

5:8acc50389659

Commit message:

update document

Changed in this revision

--- a/uVGAIII.h	Mon Mar 24 19:10:21 2014 +0000
+++ b/uVGAIII.h	Mon Mar 24 19:42:30 2014 +0000
@@ -441,29 +441,106 @@
     void graphics_parameters(int function, int value);
 
 // Texts Commands
-    void set_font(char);
-    void move_cursor(int, int);
-    void text_opacity(char);
-    void text_width(int);
-    void text_height(int);
-    void text_x_gap(int);
-    void text_y_gap(int);
-    void text_bold(char);
-    void text_inverse(char);
-    void text_italic(char);
-    void text_underline(char);
-    void text_attributes(int);
-    void put_char(char);
-    void put_string(char *);
-    void text_fgd_color(int);
-    void text_bgd_color(int);
-    void char_width(char);
-    void char_height(char);
-
-    void locate(char, char);
-    void color(int);
-    void putc(char);
-    void puts(char *);
+/**
+*  Set font mode
+* @param mode 0 for FONT1 = system font; 1 for FONT2; 2 for FONT3 = Default font
+*/
+    void set_font(char mode);
+/**
+*  Move teh text cursor to a screen postion
+* @param line Line position
+* @param column Column position
+*/
+    void move_cursor(int line, int column);
+/**
+*  Set whether or not the 'background' pixels are drawn
+* @param mode 1 for ON(opaque), 0 for OFF(transparent)
+*/
+    void text_opacity(char mode);
+/**
+*  Set the text width multiplier between 1 and 16
+* @param multiplier Width multiplier 1 to 16
+*/
+    void text_width(int multiplier);
+/**
+*  Set the text height multiplier between 1 and 16
+* @param multiplier Height multiplier 1 to 16
+*/
+    void text_height(int multiplier);
+/**
+*  Set the pixel gap between characters(x-axis)
+* @param pixelcount 0 to 32
+*/
+    void text_x_gap(int pixelcount);
+/**
+*  Set the pixel gap between characters(y-axis)
+* @param pixelcount 0 to 32
+*/
+    void text_y_gap(int pixelcount);
+/**
+*  Set the bold attribute for the text
+* @param mode 1 for ON, 0 for OFF
+*/
+    void text_bold(char mode);
+/**
+*  Inverse the background and foreground color of the text
+* @param mode 1 for ON, 0 for OFF
+*/
+    void text_inverse(char mode);
+/**
+*  Set the text to italic
+* @param mode 1 for ON, 0 for OFF
+*/
+    void text_italic(char mode);
+/**
+*  Set the text to underlined
+* @param mode 1 for ON, 0 for OFF
+*/
+    void text_underline(char mode);
+/**
+*  Control several functions grouped, Text Bold, Text Italic, Text Inverse, Text Underlined
+* @param value DEC 16 for BOLD, DEC 32 for ITALIC, DEC 64 for INVERSE, DEC 128 for UNDERLINED
+*/
+    void text_attributes(int value);
+/**
+*  Print a single character on the display
+* @param c Character to be print on the screen
+*/
+    void put_char(char c);
+/**
+*  Print a string on the display
+* @param s A Null terminated string
+*/
+    void put_string(char *s);
+/**
+*  Set the text foreground color
+* @param color Specify the color to be set
+*/
+    void text_fgd_color(int color);
+/**
+*  Set the text background color
+* @param color Specify the color to be set
+*/
+    void text_bgd_color(int color);
+/**
+*  calculate the width in pixel units for a character
+* @param c Character for the width calculation
+*/
+    void char_width(char c);
+/**
+*  calculate the height in pixel units for a character
+* @param c Character for the height calculation
+*/
+    void char_height(char c);
+/** place char at current cursor position
+*   used by virtual printf function _putc
+* @param c Character to be printed out
+*/
+    void putc(char c);
+/** place string at current cursor position
+* @param s String to be printed out
+*/
+    void puts(char *s);
 
 // Touch Command
     void detect_touch_region(int, int, int, int);

--- a/uVGAIII_Text.cpp	Mon Mar 24 19:10:21 2014 +0000
+++ b/uVGAIII_Text.cpp	Mon Mar 24 19:42:30 2014 +0000
@@ -369,17 +369,6 @@
 }
 
 //****************************************************************************************************
-void uVGAIII :: locate(char col, char row) {   // place text curssor at col, row
-    current_col = col;
-    current_row = row;
-}
-
-//****************************************************************************************************
-void uVGAIII :: color(int color) {   // set text foreground color
-    current_color = color;
-}
-
-//****************************************************************************************************
 void uVGAIII :: putc(char c)      // place char at current cursor position
                                    //used by virtual printf function _putc
 {