Diff: RGBmatrixPanel.h

Revision:

12:e632883f319f

Parent:

10:db4941188812

Child:

13:0ceb1b8893e9

--- a/RGBmatrixPanel.h	Sun May 25 12:36:39 2014 +0000
+++ b/RGBmatrixPanel.h	Sun May 25 13:41:34 2014 +0000
@@ -11,32 +11,86 @@
 #define log_debug(...)
 #endif
 
+/** RGBmatrixPanel is class for full color LED matrix
+ *
+ */
 class RGBmatrixPanel : public Adafruit_GFX
 {
 
 public:
     // Constructor for 16x32 panel:
     RGBmatrixPanel(PinName r1,PinName g1,PinName b1,PinName r2,PinName g2,PinName b2,PinName a,PinName b,PinName c,PinName sclk,PinName latch,PinName oe, bool dbuf);
-//    RGBmatrixPanel(PinName r1,PinName r2,PinName g1,PinName g2,PinName b1,PinName b2,PinName a,PinName b,PinName c,PinName sclk,PinName latch,PinName oe,bool dbuf);
 
     // Constructor for 32x32 panel (adds 'd' pin):
-    //RGBmatrixPanel(PinName r1,PinName r2,PinName g1,PinName g2,PinName b1,PinName b2,PinName a,PinName b,PinName c,PinName d,PinName sclk, PinName latch,PinName oe,bool dbuf);
+    RGBmatrixPanel(PinName r1,PinName r2,PinName g1,PinName g2,PinName b1,PinName b2,PinName a,PinName b,PinName c,PinName d,PinName sclk, PinName latch,PinName oe,bool dbuf);
 
+    /** Attach a updateDisplay() to be called by the Ticker(every 100us)
+     *
+     */
     void begin(void);
-    virtual void drawPixel(int16_t x, int16_t y, uint16_t c);
+    /** @fn void RGBmatrixPanel::drawPixel(int16_t x, int16_t y, uint16_t c)
+    *   @bref drawPixel
+    */
+    virtual void drawPixel(int16_t x,int16_t y,uint16_t c);
+    /** @fn void RGBmatrixPanel::fillScreen(uint16_t c)
+    *   @bref fillScreen
+    *   @param  c   fill screen 16bit color 0x0000 ~ 0xFFFF
+    */
     virtual void fillScreen(uint16_t c);
+    /** @fn void RGBmatrixPanel::updateDisplay(void)
+    *   @param c    updateDisplay\\
+    *               This method is called by the interrupt start at begin().
+    */
     void updateDisplay(void);
-    void swapBuffers(bool);
+    /** @fn void RGBmatrixPanel::swapBuffers(bool copy)
+    *   @param  copy swap buffer (if you use double-buffer)
+    */
+    void swapBuffers(bool copy);
+    /** @fn void RGBmatrixPanel::dumpMatrix(void)
+    *   @bref dump to default USB Serial\\
+    *         Declaration is required to use.(#define DEBUG)
+    */
     void dumpMatrix(void);
 
     uint8_t *backBuffer(void);
 
+    /** @fn void RGBmatrixPanel::Color333(uint8_t r, uint8_t g, uint8_t b)
+    *   @bref up convert to 16bit color from 9bit color.
+    *   @return 16bit(uint16_t) color value
+    */
     uint16_t Color333(uint8_t r, uint8_t g, uint8_t b);
+    /** @fn void RGBmatrixPanel::Color444(uint8_t r, uint8_t g, uint8_t b)
+    *   @bref up convert to 16bit color from 12bit color.
+    *   @return 16bit(uint16_t) color value
+    */
     uint16_t Color444(uint8_t r, uint8_t g, uint8_t b);
+    /** @fn void RGBmatrixPanel::Color888(uint8_t r, uint8_t g, uint8_t b)
+    *   @bref down convert to 16bit color from 24bit color.
+    *   @return 16bit(uint16_t) color value
+    */
     uint16_t Color888(uint8_t r, uint8_t g, uint8_t b);
+    /** @fn void RGBmatrixPanel::Color888(uint8_t r, uint8_t g, uint8_t b, bool gflag)
+    *   @bref down convert to 16bit color from 24bit color using the gamma value table.
+    *   @return 16bit(uint16_t) color value
+    */
     uint16_t Color888(uint8_t r, uint8_t g, uint8_t b, bool gflag);
-    uint16_t ColorHSV(long hue, uint8_t sat, uint8_t val, bool gflag);
-
+    /** @fn void RGBmatrixPanel::ColorHSV(long hue, uint8_t sat, uint8_t val, bool gflag)
+    *   @bref convert to 16bit color from (unsigned integer)HSV color using the gamma value table.
+    *   @param hue 0~1536(decimal value)
+    *   @param sat 0~255(decimal value) Does not make sense that it is not a multiple of 32.
+    *   @param val 0~255(decimal value) Does not make sense that it is not a multiple of 32.
+    *   @return 16bit(uint16_t) color value
+    */
+    uint16_t ColorHSV(long hue, uint8_t sat, uint8_t val, bool gflag)
+    ;
+    /** @fn void RGBmatrixPanel::ColorHSV(float hue, float sat, float val, bool gflag)
+    *   @bref convert to 16bit color from (float)HSV color using the gamma value table.
+    *   @param hue Normalized value from 0.0 to 1.0
+    *   @param sat Normalized value from 0.0 to 1.0
+    *   @param val Normalized value from 0.0 to 1.0
+    *   @return 16bit(uint16_t) color value
+    */
+    uint16_t ColorHSV(float hue, float sat, float val, bool gflag);
 private:
     uint8_t *matrixbuff[2];
     uint8_t nRows;