sGUI  V1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Modules Pages
lcd.h File Reference

Simple graphic library main functionality. More...

#include <stdint.h>
#include "lcd_conf.h"
#include "color.h"
#include "font.h"
#include "lcd_lld.h"
+ Include dependency graph for lcd.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _BMP_Header
 Bitmap header. More...
 
struct  _BMP
 Bitmap image. More...
 

Typedefs

typedef struct _BMP_Header BMP_Header
 Bitmap header.
 
typedef struct _BMP BMP
 Bitmap image.
 
typedef enum _BMP_STATUS BMP_STATUS
 Error codes.
 

Enumerations

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
}
 Error codes. More...
 

Functions

void LCD_SetTextColor (LCDCOLOR Color)
 Sets the Text color. More...
 
void LCD_SetBackColor (LCDCOLOR Color)
 Sets the Background color. More...
 
void LCD_SetFont (FONT_T *pFont)
 Sets the current font. More...
 
FONT_TLCD_GetFont (void)
 Gets the current font. More...
 
uint8_t LCD_GetLineCount (void)
 Gets the current count of possible lines. More...
 
void LCD_ClearLine (uint8_t Line)
 Clears the selected line. More...
 
void LCD_DisplayCharXY (uint16_t x, uint16_t y, char Ascii)
 Displays one character (16dots width, 24dots height) on the LCD. Position is set with a x- and a y-coordinate. More...
 
void LCD_DisplayCharLine (uint8_t Line, uint8_t Column, char Ascii)
 Displays one character (16dots width, 24dots height) on the LCD. Position is set with a line and a column. More...
 
void LCD_DisplayStringXY (uint16_t x, uint16_t y, const char *ptr)
 Displays a string on the LCD. Position is set with the x- and y-coordinate. More...
 
void LCD_DisplayStringLine (uint8_t Line, const char *ptr)
 Displays a string on a line on the LCD. Position is set with a line number. More...
 
void LCD_DisplayStringCenterLine (uint8_t Line, const char *ptr)
 Displays a string on the LCD. Position is set at the y-coordinate on center of the display. More...
 
void LCD_Log_AddMsg (char *ptr)
 Add a log message to the screen. More...
 
void LCD_Log_Update (void)
 Update the log messages on the display. This is used, if the screen is overwritten by user.
 
void LCD_DrawLine (uint16_t Xstart, uint16_t Ystart, uint16_t Xstop, uint16_t Ystop, LCDCOLOR Color)
 Draw a line on the display starting at (Xstart/Ystart) and ending at (Xstop/Ystop). This function draws the line with the Bresenham's line algorithm. More...
 
void LCD_DrawRect (uint16_t Xpos, uint16_t Ypos, uint16_t width, uint16_t height, LCDCOLOR Color)
 Displays a rectangle. More...
 
void LCD_DrawRectF (uint16_t Xpos, uint16_t Ypos, uint16_t width, uint16_t height, LCDCOLOR Color)
 Displays a filled rectangle. More...
 
void LCD_DrawCircle (uint16_t Xpos, uint16_t Ypos, uint16_t Radius, LCDCOLOR Color)
 Displays a circle. More...
 
void LCD_DrawCircleF (uint8_t Xpos, uint16_t Ypos, uint16_t Radius, LCDCOLOR Color)
 Displays a filled circle. More...
 
BMP_STATUS LCD_BMP_DrawBitmap (const char *filename, uint16_t Xpos, uint16_t Ypos)
 Reads the specified BMP image file and print it to the LCD.
It does only read bitmaps with 16, 24 or 32 bits per pixel and uncompressed.
To use this, the fatfs must be mounted. More...
 
BMP_STATUS LCD_BMP_ReadFile (BMP *bmp, const char *filename)
 Reads the specified BMP image file.
It does only read bitmaps with 16, 24 or 32 bits per pixel and uncompressed. To use this, the fatfs must be mounted. More...
 
uint32_t LCD_BMP_GetWidth (BMP *bmp)
 Returns the image's width. More...
 
uint32_t LCD_BMP_GetHeight (BMP *bmp)
 Returns the image's height. More...
 
uint16_t LCD_BMP_GetDepth (BMP *bmp)
 Returns the image's color depth (bits per pixel). More...
 
BMP_STATUS LCD_BMP_GetPixelRGB (BMP *bmp, uint32_t x, uint32_t y, uint8_t *r, uint8_t *g, uint8_t *b)
 Populates the arguments with the specified pixel's RGB values. More...
 
const char * LCD_BMP_GetErrorDescription (uint8_t errorcode)
 Returns a description of the last error code. More...
 
static void LCD_Clear (LCDCOLOR Color)
 Clears the whole LCD. More...
 

Detailed Description

Simple graphic library main functionality.

Version
1.0
Date
2013-06-07
Author
rct1

This software can be used by students and other personal of the Bern University of Applied Sciences under the terms of the MIT license. For other persons this software is under the terms of the GNU General Public License version 2.

Copyright © 2013, Bern University of Applied Sciences. All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

GNU GENERAL PUBLIC LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Definition in file lcd.h.