Diff: RA8875.h

Revision:

43:3becae133285

Parent:

41:2956a0a221e5

Child:

44:207594dece70

diff -r 7cbdfd2bbfc5 -r 3becae133285 RA8875.h
--- a/RA8875.h	Sun Feb 23 17:58:39 2014 +0000
+++ b/RA8875.h	Sun Mar 09 23:45:23 2014 +0000
@@ -135,6 +135,24 @@
     /// at startup, and not at runtime.
     //~RA8875();
     
+    /// Select the layer for subsequent commands.
+    ///
+    /// If the screen configuration is 480 x 272, or if it is 800 x 480 
+    /// and 8-bit color, the the display supports two layers, which can 
+    /// be independently drawn on and shown. Additionally, complex
+    /// operations involving both layers are permitted.
+    ///
+    /// @note The user manual refers to Layer 1 and Layer 2, however the
+    ///     actual register values are value 0 and 1. This and other APIs
+    ///     use the values 0 and 1.
+    ///
+    /// @param layer selects the layer for subsequence commands, where
+    ///     the values 0 and 1 represent layers 1 and 2 (as referred
+    ///     to in the user manual).
+    /// @returns success/failure code. @see RetCode_t.
+    ///
+    RetCode_t SelectLayer(uint16_t layer);
+    
     /// Write a command to the display with a word of data.
     ///
     /// This is a high level command, and may invoke several primitives.
@@ -241,6 +259,12 @@
     ///
     virtual dim_t height(void);
 
+    /// get the color depth in bits per pixel.
+    ///
+    /// @returns 8 or 16 only.
+    ///
+    virtual dim_t color_bpp(void);
+
     /// Set cursor position based on the current font size.
     /// 
     /// @param column is the horizontal position in character positions
@@ -901,9 +925,18 @@
     /// Initialize the chip, which is normally done as part of the
     /// constructor, so not called by the user.
     ///
+    /// @note This API permits configuration, however it is not [yet]
+    ///     available to the end user. Be sure the parameters
+    ///     are consistent with each other - see the RA8875 user
+    ///     manual.
+    ///
+    /// @param width in pixels to configure the display for.
+    /// @param height in pixels to configure the display for.
+    /// @param color_bpp can be either 8 or 16, but must be consistent
+    ///     with the width and height parameters.
     /// @returns success/failure code. @see RetCode_t.
     ///
-    RetCode_t init(void);
+    RetCode_t init(int width, int height, int color_bpp);
     
     /// method indicating the start of a graphics stream.
     ///