Component: GLCD Template (Displays: Graphical)

From Flowcode Help
Jump to navigationJump to search
Author Matrix Ltd
Version 1.5 (Release)
Category Displays: Graphical


Image GLCD Template 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 Template:

-
Image GLCD (EB043_00_1) Graphical display component designed to work with the legacy version 1 EB043 E-blocks.
Image GLCD (EB043_00_2) Graphical display component designed to work with the legacy version 2 EB043 E-blocks.
Image GLCD (EB057) Graphical display component designed to work with the EB057 modules and EB058 E-blocks.
Image 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.

Image 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.

Image 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.

Image 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.

Image GLCD (ILI9341) Graphical display component designed to work with the ILI9341 controller IC

Based on the ILI9341 16-bit colour graphical controller IC.

Image GLCD (KS0108) Graphical display component designed to work with the KS0108 type monochrome displays.
Image GLCD (SSD1289) Graphical display component based on the SSD1289 16-bit colour graphical controller IC.
Image GLCD (SSD1305) Graphical display component based on the SSD1305 monochrome graphical controller IC.
Image 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.

Image GLCD (SSD1306) Graphical display component based on the SSD1306 monochrome graphical controller IC.
Image 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.

Image 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.

Image 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.

Image 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.

Image GLCD (SSD1351) Graphical display component based on the SSD1251 16-bit colour graphical controller IC.
Image 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.

Image GLCD (ST7565R) Parallel Graphical display component designed to work with the ST7565 type monochrome displays.

Transfers data using an 8-bit digital data bus.

Image 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.

Image GLCD (T6963C) A Graphical LCD component to drive displays fitted with a T6963C controller IC.

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


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


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.

Retrieved from "https://www.matrixtsl.com/wikiv6/index.php?title=Component:_GLCD_Template_(Displays:_Graphical)&oldid=18162"