Diff: SPI_TFT_ILI9341.h

Revision:

11:7aabc3810093

Parent:

10:2d505d14b7eb

--- a/SPI_TFT_ILI9341.h	Sat Apr 12 20:33:24 2014 +0000
+++ b/SPI_TFT_ILI9341.h	Tue Apr 22 19:10:47 2014 +0000
@@ -25,8 +25,10 @@
 //Always disable for KL25Z since it does not support 16 bit SPI.
 #define SPI_16               0
 #else
-//Disable anyhow since 16 bit SPI does not really seem to improve performance..
+//Disable anyhow
 //#define SPI_16               0
+
+//Enable 16 bit SPI. Does improve performance for fill operations.
 #define SPI_16               1
 #endif
 
@@ -334,9 +336,9 @@
    */    
   virtual int columns(void);
     
-  /** calculate the max number of columns
+  /** calculate the max number of rows
    *
-   * @returns max column
+   * @returns max row
    * depends on actual font size
    *
    */   
@@ -435,20 +437,28 @@
    *
    */  
 //WH  void set_orientation(unsigned int o);
+
+
+  /** Set the origin of the screen
+   *  x,y: 0,0 is always top left 
+   *
+   * @param origin top left corner of the screen 
+   * @return None   
+   */  
   void set_origin(Origin origin);
 
   
-  /** Set background transparancy for characters
+  /** Set background transparancy for characters, meaning that background pixels remain unchanged
    *
    * @param state transparancy on/off  
-   *
+   * @return None      
    */  
    void set_transparancy(bool state);
   
   /** Enable the ILI9341 display 
    *
    * @param on: display On/Off 
-   *
+   * @return None      
    */    
   void tft_on(bool on);
   
@@ -466,8 +476,8 @@
    * @param x0 horizontal start
    * @param x1 horizontal stop
    * @param y vertical position
-   * @param color 16 bit color                                               
-   *
+   * @param color 16 bit color 
+   * @return None                                                       
    */
   void hline(int x0, int x1, int y, int colour);
     
@@ -477,6 +487,7 @@
    * @param y0 vertical start 
    * @param y1 vertical stop
    * @param color 16 bit color
+   * @return None         
    */
   void vline(int x, int y0, int y1, int colour);
     
@@ -486,22 +497,26 @@
    * @param y vertical position
    * @param w window width in pixel
    * @param h window height in pixels
+   * @return None         
    */    
   virtual void window (unsigned int x,unsigned int y, unsigned int w, unsigned int h);
     
   /** Set draw window region to whole screen
    *
+   * @return None         
    */  
   void window_max (void);
  
     
   /** Init the ILI9341 controller 
    *
+   * @return None         
    */    
   void tft_reset();
   
   
   /** HW Reset to ILI9341 controller
+   * @return None        
    */
   void _hwreset();
   
@@ -509,7 +524,7 @@
    /** Write data to the LCD controller
    *
    * @param dat data written to LCD controller
-   * 
+   * @return None         
    */   
   //void wr_dat(unsigned int value);
   void wr_dat(unsigned char value);
@@ -517,32 +532,14 @@
   /** Write a command the LCD controller 
    *
    * @param cmd: command to be written   
-   *
+   * @return None         
    */   
   void wr_cmd(unsigned char value);
     
-   /** Start data sequence to the LCD controller
-   * 
-   */   
-  //void wr_dat_start();
-    
-  /** Stop of data writing to the LCD controller
-   *   
-   */  
-  //void wr_dat_stop();
-    
-  /** write data to the LCD controller
-   *
-   * @param data to be written 
-   *                                           *
-   */    
-  //void wr_dat_only(unsigned short dat);
-    
   /** Read byte from the LCD controller
    *
    * @param cmd command to controller
    * @returns data from LCD controller
-   *  
    */    
    char rd_byte(unsigned char cmd);
     
@@ -551,7 +548,6 @@
    *
    * @param cmd command to controller
    * @returns data from LCD controller
-   *  
    */    
    int rd_32(unsigned char cmd);  
     
@@ -560,6 +556,7 @@
    *
    * @param reg register to be written
    * @param val data to be written
+   * @return None         
    */   
   //void wr_reg (unsigned char reg, unsigned char val);
     
@@ -581,7 +578,7 @@
   unsigned int   _char_y;
   bool           _transparancy;
 
-  //WHunsigned int orientation;
+  //WH unsigned int orientation;
   Origin _origin;  
       
 };