Diff: Hexi_OLED_SSD1351.h

Revision:

7:9961c525e249

Parent:

6:0060ffa3f4dc

diff -r 0060ffa3f4dc -r 9961c525e249 Hexi_OLED_SSD1351.h
--- a/Hexi_OLED_SSD1351.h	Fri Aug 26 19:56:07 2016 +0000
+++ b/Hexi_OLED_SSD1351.h	Fri Aug 26 22:54:49 2016 +0000
@@ -56,6 +56,14 @@
   * @param csPin   OLED Chip Select Pin
   * @param rstPin  OLED Reset Pin
   * @param dcPin   OLED DC Pin
+  *
+  * @note Default TextProperties
+  *
+  *       .font       = OpenSans_10x15_Regular,    
+  *       .fontColor  = COLOR_WHITE,
+  *       .alignParam = OLED_TEXT_ALIGN_CENTER, 
+  *       .background = NULL
+  *
   */
   SSD1351(PinName mosiPin,PinName sclkPin,PinName pwrPin, PinName csPin,PinName rstPin, PinName dcPin);
 
@@ -165,11 +173,16 @@
 
 
   /**
-   * Set OLED text properties
+   * Set OLED class text properties from parameter 
    * @param textProperties data-structure with desired properties
    */
   void SetTextProperties(oled_text_properties_t *textProperties);
 
+  /**
+   * Copy OLED class text properties to parameter
+   * @param textProperties destination data-structure
+   */
+  void GetTextProperties(oled_text_properties_t *textProperties);
 
   /**
    * Return the width in [px] required for the given string to be displayed
@@ -348,8 +361,8 @@
 
   uint16_t
     selectedFont_color,
-    selectedFont_firstChar, // first character in the font table
-    selectedFont_lastChar,  // last character in the font table
+    selectedFont_firstChar, /* first character in the font table */
+    selectedFont_lastChar,  /* last character in the font table */
     selectedFont_height,
     colorMask;
 
@@ -357,7 +370,7 @@
   oled_text_properties_t oled_text_properties;
 
   
-  //Internal Functions
+  /* Internal Functions */
   void Transpose( oled_pixel_t transImage, const oled_pixel_t image, uint8_t width, uint8_t height );
   oled_status_t TopDown   ( const uint8_t* image, int8_t xCrd, int8_t yCrd, uint8_t width, uint8_t height );
   oled_status_t DownTop   ( const uint8_t* image, int8_t xCrd, int8_t yCrd, uint8_t width, uint8_t height );