Component: GLCD Base (Displays: Graphical)

Author	Matrix Ltd
Version	1.5 (Development)
Category	Displays: Graphical

GLCD Base component

Base graphical LCD with simulation only interface to allow graphics to be drawn in simulation. Suitable for inheriting to simplify the creation of further graphical LCD components.

This component can be used as a base to create child components

The following components all inherit the traits of GLCD Base:

-

GLCD (EB043_00_1)	Graphical display component designed to work with the legacy version 1 EB043 E-blocks.
GLCD (EB043_00_2)	Graphical display component designed to work with the legacy version 2 EB043 E-blocks.
GLCD (EB057)	Graphical display component designed to work with the EB057 modules and EB058 E-blocks.
GLCD (EB075, 4D_Goldelox)	Graphical display component designed to work with the Goldelox range of displays from 4D Systems. Also available in the form of the EB075 GLCD E-block.
GLCD (EB076v2, 4D_Picaso)	Graphical display component designed to work with the Picaso range of displays from 4D Systems. Also available in the form of the EB076 GLCD Touchscreen E-block. Component based around the uLCD-32PTU display.
GLCD (EB076, 4D_Picaso)	Graphical display component designed to work with the Picaso range of displays from 4D Systems. Also available in the form of the EB076 GLCD Touchscreen E-block. Component based around the uLCD-32PT display.
GLCD (EBM001)	Graphical display component designed to work with the EBM001 modules and EB084 E-blocks. Based on the ILI9163C 16-bit colour graphical controller IC.
GLCD (ILI9341)	Graphical display component designed to work with the ILI9341 controller IC Based on the ILI9341 16-bit colour graphical controller IC.
GLCD (KS0108)	Graphical display component designed to work with the KS0108 type monochrome displays. Also compatible with the newer S6A0107 controller IC displays.
GLCD (SH1106) I2C	Graphical display component designed to work with the SH1106 type monochrome displays. Transfers data using a 2-wire I2C interface.
GLCD (SH1106) SPI	Graphical display component designed to work with the SH1106 type monochrome displays. Transfers data using a 4-wire SPI interface.
GLCD (SSD1289)	Graphical display component based on the SSD1289 16-bit colour graphical controller IC.
GLCD (SSD1305)	Graphical display component based on the SSD1305 monochrome graphical controller IC.
GLCD (SSD1305) Buffered	Graphical display component based on the SSD1305 monochrome graphical controller IC. Functions without the use of a read pin by hosting the 1K of graphical memory using the microcontroller's RAM memory.
GLCD (SSD1306)	Graphical display component based on the SSD1306 monochrome graphical controller IC.
GLCD (SSD1306) Buffered	Graphical display component based on the SSD1306 monochrome graphical controller IC. Functions without the use of a read pin by hosting the 1K of graphical memory using the microcontroller's RAM memory.
GLCD (SSD1306) I2C	Graphical display component based on the I2C version of the SSD1306 monochrome graphical controller IC. Functions without the use of a read pin by hosting the 1K of graphical memory using the microcontroller's RAM memory.
GLCD (SSD1306) SPI	Graphical display component based on the SPI version of the SSD1306 monochrome graphical controller IC. Functions without the use of a read pin forcing the data to be written a byte at a time.
GLCD (SSD1322) Parallel	Graphical display component designed to work with the SSD1322 type monochrome displays. Compatible with 6800 and 8080 type 8-bit parallel displays.
GLCD (SSD1322) Buffered	Graphical display component based on the SSD1322 monochrome graphical controller IC. Functions without the use of a read pin by hosting the 2K of graphical memory using the microcontroller's RAM memory.
GLCD (SSD1351)	Graphical display component based on the SSD1251 16-bit colour graphical controller IC.
GLCD (SSD1963) Parallel	Graphical display component designed to work with the SSD1963 controller IC Based on the SSD1963 16-bit colour graphical controller IC.
GLCD (ST7036) I2C	Graphical display component based on the I2C version of the ST7036 monochrome graphical controller IC. Functions without the use of a read pin by hosting the 1K of graphical memory using the microcontroller's RAM memory.
GLCD (ST7565R) Parallel	Graphical display component designed to work with the ST7565 type monochrome displays. Transfers data using an 8-bit digital data bus.
GLCD (ST7565R) SPI	Graphical display component designed to work with the ST7565 type monochrome displays. Transfers data using a 4-wire SPI interface, cannot read back so pixel based routines won't work Not for public release.
GLCD (ST7567) SPI	Graphical display component designed to work with the ST7567 type monochrome displays. Transfers data using a 4-wire SPI interface, cannot read back so pixel based routines won't work Not for public release.
GLCD (STM32F429ZI)	Graphical display component designed to work with the STM32F429ZI Discovery board from ST. Compatible with the large display and resistive touch input.
GLCD (STM32F469NI)	Graphical display component designed to work with the STM32F469NI Discovery board from ST. Compatible with the large display and capacitive touch input.
GLCD (STM32F746NG)	Graphical display component designed to work with the STM32F746NG Discovery board from ST. Compatible with the large display and capacitive touch input.
GLCD (T6963C)	A Graphical LCD component to drive displays fitted with a T6963C controller IC.
GLCD (TLS8201)	A Graphical LCD component to drive displays fitted with a TLS8201 controller IC.
GLCD (UC1701)	Graphical display component based on the UC1701 monochrome graphical controller IC.

Detailed description

Font sizes

Standard Fonts

0 = Normal

1 = 2 x Width

2 = 2 x Width and 2 x Height

3 = 2 x Height

Extended Fonts

4 = 2 x Width and 3 x Height

5 = 2 x Width and 4 x Height

6 = 2 x Width and 5 x Height

7 = 2 x Width and 6 x Height

8 = 3 x width

9 = 3 x Width and 2 x Height

10 = 3 x Width and 3 x Height

11 = 3 x Width and 4 x Height

12 = 3 x Width and 5 x Height

13 = 3 x Width and 6 x Height

14 = 4 x width

15 = 4 x Width and 2 x Height

16 = 4 x Width and 3 x Height

17 = 4 x Width and 4 x Height

18 = 4 x Width and 5 x Height

19 = 4 x Width and 6 x Height

20 = 5 x width

21 = 5 x Width and 2 x Height

22 = 5 x Width and 3 x Height

23 = 5 x Width and 4 x Height

24 = 5 x Width and 5 x Height

25 = 5 x Width and 6 x Height

26 = 6 x width

27 = 6 x Width and 2 x Height

28 = 6 x Width and 3 x Height

29 = 6 x Width and 4 x Height

30 = 6 x Width and 5 x Height

31 = 6 x Width and 6 x Height

Examples

No additional examples

Downloadable macro reference

ReadASCIILUT

Gets a byte of the embedded ASCII font data.

Parameters

BYTE pos_str

ASCII position -32 so A = 'A' - 32 = 33

BYTE count

Font column Ranging 0-4

Return value

BYTE

Simulation macro reference

PrintNumber

This macro prints a decimal number to the Graphical LCD.

Parameters

INT Number

Byte or Integer number to send to the display.

UINT X

X pixel coordinate to set the output string position.

UINT Y

Y pixel coordinate to set the output string position.

BYTE Font

Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height

BYTE Transparent

Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

Return value

This call does not return a value

DrawLine

Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

Parameters

UINT X1

UINT Y1

UINT X2

UINT Y2

Return value

This call does not return a value

Plot

Sets a pixel with the current foreground colour at pixel location X, Y.

Parameters

UINT X1

UINT Y1

Return value

This call does not return a value

DrawEllipse

Draws an ellipse object on the display with the center of the ellipse at the location X,Y

Parameters

UINT X

X Coordinate for the center of the circle

UINT Y

Y coordinate for the center of the circle

UINT XRadius

Radius of the circle on the X axis specified in pixels

UINT YRadius

Radius of the circle on the Y axis specified in pixels

BYTE Transparent

0=Fill inside circle using background colour / 1=Draw outer circle only

BYTE Solid

0=Use Transparent Setting / 1=Fill with foreground colour

Return value

This call does not return a value

SetDisplayOrientation

Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

Parameters

BYTE Orientation

0=Default, 1=90°CW, 2=180°CW, 3=270°CW

Return value

This call does not return a value

BPlot

Sets a pixel with the current background colour at pixel location X, Y.

Parameters

UINT X1

UINT Y1

Return value

This call does not return a value

Print

This macro prints a string of characters to the Graphical LCD.

Parameters

<- STRING Str

String of characters to send to the display.

This parameter may be returned back to the caller

UINT X1

X pixel coordinate to set the output string position.

UINT Y1

Y pixel coordinate to set the output string position.

BYTE Font

Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height

BYTE Transparent

Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

Return value

This call does not return a value

ClearDisplay

This macro clears the display of any previous output by overwriting the entire display with the background colour.

Parameters

This macro has no parameters

Return value

This call does not return a value

SetBackgroundColour

Specifies the colour of the background by creating a mixture of red, green and blue.

Parameters

BYTE Red

0 - 255 where 0 = no red and 255 = maximum red

BYTE Green

0 - 255 where 0 = no green and 255 = maximum green

BYTE Blue

0 - 255 where 0 = no blue and 255 = maximum blue

Return value

This call does not return a value

DrawCircle

Draws a circle object on the display with the center of the circle at the location X,Y

Parameters

UINT X

X Coordinate for the center of the circle

UINT Y

Y coordinate for the center of the circle

UINT Radius

Radius of the circle specified in pixels

BYTE Transparent

0=Fill inside circle using background colour / 1=Draw outer circle only

BYTE Solid

0=Use Transparent Setting / 1=Fill with foreground colour

Return value

This call does not return a value

SetForegroundColour

Specifies the colour of the foreground by creating a mixture of red, green and blue.

Parameters

BYTE Red

0 - 255 where 0 = no red and 255 = maximum red

BYTE Green

0 - 255 where 0 = no green and 255 = maximum green

BYTE Blue

0 - 255 where 0 = no blue and 255 = maximum blue

Return value

This call does not return a value

DrawRectangle

Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2.

Parameters

UINT X1

UINT Y1

UINT X2

UINT Y2

BYTE Transparent

Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.

BYTE Solid

Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.

Return value

This call does not return a value

Initialise

The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.

Parameters

This macro has no parameters

Return value

This call does not return a value

Property reference

Pixel Height

This property is of type Unsigned integer and can be referenced with the variable name pixel_height.

Heigt of gLCD canvas measured in pixels.

Pixel Width

This property is of type Unsigned integer and can be referenced with the variable name pixel_width.

Width of gLCD canvas measured in pixels.

Monochrome

This property is of type True or false and can be referenced with the variable name monochrome.

Specifies if the display is capable of colour or monochrome only.

Foreground Colour

This property is of type Color picker and can be referenced with the variable name foreground_colour.

Specifies the initial foreground color.

Background Colour

This property is of type Color picker and can be referenced with the variable name background_colour.

Specifies the initial background color.

Colour Bit Depth

This property is of type Unsigned integer and can be referenced with the variable name colour_bit_depth.

Total color bit depth for the display.

Red Bit Depth

This property is of type Unsigned integer and can be referenced with the variable name red_bit_depth.

Specifies the red bit depth for the display.

Green Bit Depth

This property is of type Unsigned integer and can be referenced with the variable name green_bit_depth.

Specifies the green bit depth for the display.

Blue Bit Depth

This property is of type Unsigned integer and can be referenced with the variable name blue_bit_depth.

Specifies the blue bit depth for the display.

Display Method

This property is of type Fixed list of ints and can be referenced with the variable name DisplayMethod.

Chooses which method to use when drawing to the gLCD component

The bitmap is the more common mode but may run slowly on some machines.

The point cloud should run faster but may use more memory.

Embed Font Set

This property is of type True or false and can be referenced with the variable name EmbedFontSet.

Specifies if the font set is included with the embedded downloadable code.

Some display types have in an built font and text functions so the embedded font set can be disabled to reduce code overhead.

For other display types the embedded font data should be enable to allow the print functions to work correctly.