Diff: Display/Display.h

Revision:

39:e1cb4dd9bfeb

Parent:

31:d47cffcb0a3e

--- a/Display/Display.h	Wed Apr 15 09:41:56 2015 +0200
+++ b/Display/Display.h	Tue Apr 28 11:47:20 2015 +0000
@@ -75,11 +75,15 @@
     
     /** Turns the display on with the specified framebuffer showing
      *
+     *  @param framebuffer  the data to show
+     *  @param res          the resolution to use
+     *  @param rate         the frame rate to use
+     *
      *  @returns
      *       Ok on success
      *       An error code on failure
      */
-    virtual DisplayError powerUp(void* framebuffer, Resolution wanted = Resolution_16bit_rgb565) = 0;
+    virtual DisplayError powerUp(void* framebuffer, Resolution res = Resolution_16bit_rgb565, FrameRate_t rate = FrameRate_Normal) = 0;
   
     /** Turns the display off
      *
@@ -91,18 +95,54 @@
   
     /** Sets the backlight level. 0% is off and 100% is fully on
      *
+     *  @param percent   backlight in %
+     *
      *  @returns
      *       Ok on success
      *       An error code on failure
      */
     virtual DisplayError backlight(int percent) = 0;
   
+    /** Returns the width (in pixels) of the display
+     *
+     *  @returns the display width
+     */
     virtual uint16_t width() = 0;
+
+    /** Returns the height (in pixels) of the display
+     *
+     *  @returns the display height
+     */
     virtual uint16_t height() = 0;
+
+    /** Returns the number of bytes used by each pixel
+     *
+     *  @returns bytes per pixel
+     */
     virtual uint16_t bytesPerPixel() = 0;
+
+    /** Returns the number of bytes used for each frame buffer
+     *
+     *  @returns width*height*bytesPerPixel
+     */
     virtual uint32_t fbSize() = 0;
+
+    /** Returns the display orientation
+     *
+     *  @returns the display orientation
+     */
     virtual bool landscape() = 0;
+
+    /** Returns true if the specified resolution can be used
+     *
+     *  @returns true if supported, false if not
+     */
     virtual bool isSupported(Resolution res) = 0;
+
+    /** Returns the current resolution
+     *
+     *  @returns the current resolution
+     */
     virtual Resolution currentResolution() = 0;
     
     /** Replaces the current framebuffer.