Rune Langoy / mcufriend_24_tft_lcd

mcufriend 2.4 TFT LCD Shield Lib

Dependents:   Nucleo_LCD_mcufriend_test

Fork of 24_TFT_STMNUCLEO by Carlos Silva

Embed: (wiki syntax)

« Back to documentation index

lcd_base.h File Reference
Data Structures | Typedefs | Enumerations

lcd_base.h File Reference

Base class for all LCD controller implementations. More...

Go to the source code of this file.

Data Structures

struct  Bitmap_struct
 Describes an image. More...
class  LCD
 Base class for LCD implementations. More...

Typedefs

typedef enum Orientation_enum orientation_t
 Convenience shortcut for display orientation.
typedef enum ColorDepth_enum colordepth_t
 Convenience shortcut for display color depth.
typedef enum Alignment_enum align_t
 Convenience shortcut for text alignment.
typedef struct Bitmap_struct bitmap_t
 Convenience shortcut bitmap type.
typedef BacklightPwmCtrl_enum backlight_t
 Convenience shortcut for the backlight control type.

Enumerations

enum  Orientation_enum { PORTRAIT = 0, LANDSCAPE = 1, PORTRAIT_REV = 2, LANDSCAPE_REV = 3 }
 

Display orientation.

More...
enum  ColorDepth_enum { RGB16, RGB18, RGB24 }
 

Color depth.

More...
enum  Alignment_enum { LEFT = 0, CENTER = 9998, RIGHT = 9999 }
 

Horizontal text alignment on the line.

More...
enum  BacklightPwmCtrl_enum { Constant, Direct, Indirect }

Detailed Description

Base class for all LCD controller implementations.

GNU Public License, v2. or later

Generic object painting and screen control.

This library is based on the Arduino/chipKIT UTFT library by Henning Karlsen, http://henningkarlsen.com/electronics/library.php?id=52

Copyright (C)2010-2012 Henning Karlsen. All right reserved.

Copyright (C)2012 Todor Todorov.

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

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to:

Free Software Foundation, Inc. 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA

Definition in file lcd_base.h.

Typedef Documentation

align_t

Convenience shortcut for text alignment.

Definition at line 127 of file lcd_base.h.

backlight_t

Convenience shortcut for the backlight control type.

Definition at line 187 of file lcd_base.h.

bitmap_t

Convenience shortcut bitmap type.

Definition at line 159 of file lcd_base.h.

colordepth_t

Convenience shortcut for display color depth.

Definition at line 113 of file lcd_base.h.

orientation_t

Convenience shortcut for display orientation.

Definition at line 99 of file lcd_base.h.

Enumeration Type Documentation

enum Alignment_enum

Horizontal text alignment on the line.

Enumerator:
LEFT 

Left-oriented, naturally gravitate closer to the left edge of the screen.

CENTER 

Center-oriented, try to fit in the middle of the available space with equal free space to the left and right of the text.

RIGHT 

Right-oriented, naturally gravitate closer to the right edge of the screen, leaving any remaining free space to the left of the text.

Definition at line 118 of file lcd_base.h.

enum BacklightPwmCtrl_enum
Enumerator:
Constant 

When the pin is a simple on/off switch.

Direct 

Control the brightness with PWM, as the control pin is sourcing the current to drive the backlight LEDs.

Indirect 

Control the brightness with PWM, as the control pin is sinking the current which drives the backlight LEDs.

Definition at line 178 of file lcd_base.h.

enum ColorDepth_enum

Color depth.

Enumerator:
RGB16 

16-bit colors, pixels can have 65K+ distinct color values

RGB18 

18-bit colors, pixels can have 262K+ distinct color values

RGB24 

24-bit colors, full 8 bits per component, 16M+ distinct color values

Definition at line 104 of file lcd_base.h.

enum Orientation_enum

Display orientation.

Enumerator:
PORTRAIT 

Top row of the screen is at 12 o'clock.

LANDSCAPE 

Top row of the screen is at 9 o'clock.

PORTRAIT_REV 

Top row of the screen is at 6 o'clock.

LANDSCAPE_REV 

Top row of the screen is at 3 o'clock.

Definition at line 89 of file lcd_base.h.

Generated on Wed Jul 13 2022 16:07:34 by  doxygen 1.7.2