Diff: GraphicsDisplay.h

Revision:

36:300f6ee0b2cf

Parent:

35:7dcab9e3ab25

Child:

37:f19b7e7449dc

--- a/GraphicsDisplay.h	Thu Jan 23 23:51:47 2014 +0000
+++ b/GraphicsDisplay.h	Sat Jan 25 00:00:02 2014 +0000
@@ -166,9 +166,14 @@
     /// This method reads a disk file that is in bitmap format and 
     /// puts it on the screen.
     ///
-    /// @note This only reads 16-bit bitmap format.
-    /// @note This is a slow operation, partially due to the use of
-    ///         the local file system, and partially because bmp files
+    /// Supported formats:
+    /// \li 4-bit color format (16 colors)
+    /// \li 8-bit color format (256 colors)
+    /// \li 16-bit color format (65k colors)
+    /// \li compression: no.
+    ///
+    /// @note This is a slow operation, typically due to the use of
+    ///         the file system, and partially because bmp files
     ///         are stored from the bottom up, and the memory is written
     ///         from the top down; as a result, it constantly 'seeks'
     ///         on the file system for the next row of information.
@@ -220,19 +225,29 @@
     ///    
     virtual int rows(void);
     
-    /// Select a bitmap font (provided by the user) for all subsequent text.
+    /// Select a bitmap font (provided by the user) for all subsequent text
+    /// rendering.
+    ///
+    /// This API permits selection of a special memory mapped font, which 
+    /// enables the presentation of many font sizes and styles, including
+    /// proportional fonts.
     ///
     /// @note Tool to create the fonts is accessible from its creator
-    ///     available at http://www.mikroe.com. 
-    ///     Change the data to an array of type char[].
+    ///     available at http://www.mikroe.com.
+    ///     Hint: Change the data to an array of type char[].
     ///
-    /// @param font is a pointer to a specially formed font array.
     ///     This special font array has a 4-byte header, followed by 
     ///     the data:
-    ///   - the number of bytes per char
-    ///   - the vertical size in pixels for each character
-    ///   - the horizontal size in pixels for each character
-    ///   - the number of bytes per vertical line (width of the array)
+    ///   \li the number of bytes per char
+    ///   \li the vertical size in pixels for each character
+    ///   \li the horizontal size in pixels for each character
+    ///   \li the number of bytes per vertical line (width of the array)
+    ///   \li the subsequent records are the font information.
+    ///
+    /// @param font is a pointer to a specially formed font array. 
+    ///     NULL, or the omission of this parameter will restore the default
+    ///     font capability, which may use the display controllers hardware
+    ///     font (if available), or no font.
     /// @returns error code.
     ///
     virtual RetCode_t set_font(const unsigned char * font = NULL);