drivers/displays/tft/lcd.h

   1 /**************************************************************************/
   2 /*!
   3     @file     lcd.h
   4     @author   K. Townsend (microBuilder.eu)
   5     @date     22 March 2010
   6     @version  0.10
   7
   8     @section LICENSE
   9
  10     Software License Agreement (BSD License)
  11
  12     Copyright (c) 2010, microBuilder SARL
  13     All rights reserved.
  14
  15     Redistribution and use in source and binary forms, with or without
  16     modification, are permitted provided that the following conditions are met:
  17     1. Redistributions of source code must retain the above copyright
  18     notice, this list of conditions and the following disclaimer.
  19     2. Redistributions in binary form must reproduce the above copyright
  20     notice, this list of conditions and the following disclaimer in the
  21     documentation and/or other materials provided with the distribution.
  22     3. Neither the name of the copyright holders nor the
  23     names of its contributors may be used to endorse or promote products
  24     derived from this software without specific prior written permission.
  25
  26     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  27     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  30     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  31     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  33     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 */
  37 /**************************************************************************/
  38 #ifndef __LCD_H__
  39 #define __LCD_H__
  40
  41 #include "projectconfig.h"
  42 #include "colors.h"
  43
  44 // Any LCD needs to implement these common methods, which allow the low-level
  45 // initialisation and pixel-setting details to be abstracted away from the
  46 // higher level drawing and graphics code.
  47
  48 typedef enum
  49 {
  50   LCD_ORIENTATION_PORTRAIT = 0,
  51   LCD_ORIENTATION_LANDSCAPE = 1
  52 } lcdOrientation_t;
  53
  54 // This struct is used to indicate the capabilities of different LCDs
  55 typedef struct
  56 {
  57   uint16_t width;         // LCD width in pixels (default orientation)
  58   uint16_t height;        // LCD height in pixels (default orientation)
  59   bool     touchscreen;   // Whether the LCD has a touch screen
  60   bool     orientation;   // Whether the LCD orientation can be modified
  61   bool     hwscrolling;   // Whether the LCD support HW scrolling
  62   bool     fastHLine;     // Whether the driver contains an accelerated horizontal line function
  63   bool     fastVLine;     // Whether the driver contains an accelerated vertical line function
  64 } lcdProperties_t;
  65
  66 extern void     lcdInit(void);
  67 extern void     lcdTest(void);
  68 extern uint16_t lcdGetPixel(uint16_t x, uint16_t y);
  69 extern void     lcdFillRGB(uint16_t data);
  70 extern void     lcdDrawPixel(uint16_t x, uint16_t y, uint16_t color);
  71 extern void     lcdDrawPixels(uint16_t x, uint16_t y, uint16_t *data, uint32_t len);
  72 extern void     lcdDrawHLine(uint16_t x0, uint16_t x1, uint16_t y, uint16_t color);
  73 extern void     lcdDrawVLine(uint16_t x, uint16_t y0, uint16_t y1, uint16_t color);
  74 extern void     lcdBacklight(bool state);
  75 extern void     lcdScroll(int16_t pixels, uint16_t fillColor);
  76 extern uint16_t lcdGetWidth(void);
  77 extern uint16_t lcdGetHeight(void);
  78 extern void     lcdSetOrientation(lcdOrientation_t orientation);
  79 extern uint16_t lcdGetControllerID(void);
  80 extern lcdOrientation_t lcdGetOrientation(void);
  81 extern lcdProperties_t lcdGetProperties(void);
  82
  83 #endif