lcd.h

Go to the documentation of this file.

#ifndef __LCD_H__
#define __LCD_H__

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/*----- Header-Files -------------------------------------------------------*/
#include <stdint.h>                 /* Standard integer formats             */
#include "lcd_conf.h"               /* LCD configuration                    */
#include "color.h"                  /* Color definitions                    */
#include "font.h"                   /* Fonts definitions                    */
#include "lcd_lld.h"                /* Graphic controller communication     */

/*----- Macros -------------------------------------------------------------*/

/*----- Data types ---------------------------------------------------------*/
typedef struct _BMP_Header {
    uint16_t Magic;             
    uint32_t FileSize;          
    uint16_t Reserved1;         
    uint16_t Reserved2;         
    uint32_t DataOffset;        
    uint32_t HeaderSize;        
    uint32_t Width;             
    uint32_t Height;            
    uint16_t Planes;            
    uint16_t BitsPerPixel;      
    uint32_t CompressionType;   
    uint32_t ImageDataSize;     
    uint32_t HPixelsPerMeter;   
    uint32_t VPixelsPerMeter;   
    uint32_t ColorsUsed;        
    uint32_t ColorsRequired;    
} BMP_Header;

typedef struct _BMP {
    BMP_Header Header;          
    uint8_t *Data;              
} BMP;

typedef enum _BMP_STATUS
{
    BMP_OK = 0,             
    BMP_ERROR,              
    BMP_OUT_OF_MEMORY,      
    BMP_IO_ERROR,           
    BMP_FILE_NOT_FOUND,     
    BMP_FILE_NOT_SUPPORTED, 
    BMP_FILE_INVALID,       
    BMP_INVALID_ARGUMENT,   
    BMP_TYPE_MISMATCH,      
    BMP_ERROR_NUM           
} BMP_STATUS;

/*----- Function prototypes ------------------------------------------------*/
/* Text functionality */
void LCD_SetTextColor(LCDCOLOR Color);
void LCD_SetBackColor(LCDCOLOR Color);
void LCD_SetFont(FONT_T *pFont);
FONT_T* LCD_GetFont(void);
uint8_t LCD_GetLineCount(void);
void LCD_ClearLine(uint8_t Line);
void LCD_DisplayCharXY(uint16_t x, uint16_t y, char Ascii);
void LCD_DisplayCharLine(uint8_t Line, uint8_t Column, char Ascii);
void LCD_DisplayStringXY(uint16_t x, uint16_t y, const char *ptr);
void LCD_DisplayStringLine(uint8_t Line, const char *ptr);
void LCD_DisplayStringCenterLine(uint8_t Line, const char *ptr);

/* Log console functionality */
void LCD_Log_AddMsg(char *ptr);
void LCD_Log_Update(void);

/* Simple geometric functionality */
void LCD_DrawLine(uint16_t Xstart, uint16_t Ystart, uint16_t Xstop,
                  uint16_t Ystop, LCDCOLOR Color);
void LCD_DrawRect(uint16_t Xpos, uint16_t Ypos, uint16_t width,
                  uint16_t height, LCDCOLOR Color);
void LCD_DrawRectF(uint16_t Xpos, uint16_t Ypos, uint16_t width,
                   uint16_t height, LCDCOLOR Color);
void LCD_DrawCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius,
                    LCDCOLOR Color);
void LCD_DrawCircleF(uint8_t Xpos, uint16_t Ypos, uint16_t Radius,
                LCDCOLOR Color);

/* Bitmap functionality */
BMP_STATUS LCD_BMP_DrawBitmap(const char *filename, uint16_t Xpos,
                              uint16_t Ypos);
BMP_STATUS LCD_BMP_ReadFile(BMP *bmp, const char *filename);
uint32_t LCD_BMP_GetWidth(BMP *bmp);
uint32_t LCD_BMP_GetHeight(BMP *bmp);
uint16_t LCD_BMP_GetDepth(BMP *bmp);
BMP_STATUS LCD_BMP_GetPixelRGB(BMP *bmp, uint32_t x, uint32_t y, uint8_t *r,
                               uint8_t *g, uint8_t *b);
const char* LCD_BMP_GetErrorDescription(uint8_t errorcode);

/*----- Data ---------------------------------------------------------------*/

/*----- Implementation -----------------------------------------------------*/
static inline void LCD_Clear(LCDCOLOR Color) {
    LCD_FillArea(SCRN_LEFT, SCRN_TOP, SCRN_RIGHT, SCRN_BOTTOM, Color);
}

/*----- EOF ----------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __LCD_H__ */