Diff: RA8875.h

Revision:

153:8a85efb3eb71

Parent:

152:a013ac0133e4

Child:

154:ad2450fc3dc3

--- a/RA8875.h	Mon Nov 06 01:41:55 2017 +0000
+++ b/RA8875.h	Sun Jul 29 00:32:51 2018 +0000
@@ -1509,13 +1509,14 @@
         alignment_t alignment = align_none);
     
 
-    /// Control the font size of the RA8875 internal fonts.
+    /// Control the font size of the RA8875 rendered fonts.
     ///
     /// This command lets you set the font enlargement for both horizontal
     /// and vertical, independent of the rotation, background, and 
     /// alignment. See @ref SetTextFontControl.
     ///
-    /// @note This command only operates on the RA8875 internal fonts.
+    /// @note This command operates on the RA8875 internal fonts.
+    /// @note This command also operates on the selected soft font.
     ///
     /// @param[in] hScale defaults to 1, but can be 1, 2, 3, or 4,
     ///     and scales the font size by this amount.
@@ -1529,6 +1530,10 @@
     ///     lcd.puts("2*2 3*h");
     ///     lcd.SetTextFontSize();      // Restore to normal size in both dimensions
     ///     lcd.puts("normal");
+    ///     lcd.SelectUserFont(BPG_Arial63x63); // Large user font
+    ///     lcd.puts("B63x63");                 // Show a sample
+    ///     lcd.SetTextFontSize(2);             // Now twice as big
+    ///     lcd.puts("x2");                     // Show a sample
     /// @endcode
     ///
     /// @note if either hScale or vScale is outside of its permitted range,
@@ -1840,6 +1845,11 @@
     /// This is similar, but different, to the @ref pixelStream API, which is 
     /// given a stream of color values.
     /// 
+    /// This is most often used for Soft Fonts, and for that reason, this method
+    /// will scale the presentation based on the selected font size. 
+    /// See @ref SetTextFontSize, So, users may want to SetTextFontSize(1) for
+    /// 1:1 scaling.
+    /// 
     /// @param[in] x is the horizontal position on the display.
     /// @param[in] y is the vertical position on the display.
     /// @param[in] w is the width of the rectangular region to fill.