Component: gLCD Font Library (Graphical Library)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 1.0 |
| Category | Graphical Library |
Contents
gLCD Font Library component
A component designed to simplify the task of creating dynamic fonts for use with graphical displays.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
ReadWidth |
| Gets the width of the ASCII character font data | |
 - BYTE
|
Character |
| ASCII position so A = 'A' | |
| - BYTE
|
Return |
|
|
ReadFontStat |
| Collects a stat about the selected font | |
| - BYTE
|
Index |
| 0=SpaceColumns, 1=CharacterHeight | |
| - BYTE
|
Return |
|
|
ReadASCIILUT |
| Gets a single pixel column byte from the selected ASCII character font data. | |
| - BYTE
|
Character |
| ASCII position so A = 'A' | |
| - BYTE
|
ByteIndex |
| Range: 0 to ((PixelWidth - 1) * BytesPerColumn) | |
| - BYTE
|
Return |
|
|
DrawEllipse |
| Draws an ellipse object on the display with the center of the ellipse at the location X,Y | |
 - 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 | |
 - VOID
|
Return |
|
|
SetDisplayOrientation |
| Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. | |
| - BYTE
|
Orientation |
| 0=Default, 1=90°CW, 2=180°CW, 3=270°CW | |
| - VOID
|
Return |
|
|
BPlot |
| Sets a pixel with the current background colour at pixel location X, Y. | |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - VOID
|
Return |
|
|
|
| This macro prints a string of characters to the Graphical LCD. | |
 - STRING
|
Str |
| String of characters to send to the display. | |
| - UINT
|
X1 |
| X pixel coordinate to set the output string position. | |
| - UINT
|
Y1 |
| Y pixel coordinate to set the output string position. | |
| - BYTE
|
Font |
| Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes | |
| - BYTE
|
Transparent |
| Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. | |
| - VOID
|
Return |
|
|
ClearDisplay |
| This macro clears the display of any previous output by overwriting the entire display with the background colour. | |
| - VOID
|
Return |
|
|
SetBackgroundColour |
| Specifies the colour of the foreground | |
| - BYTE
|
R |
| - BYTE
|
G |
| - BYTE
|
B |
| - VOID
|
Return |
|
|
DrawCircle |
| Draws a circle object on the display with the center of the circle at the location X,Y | |
| - 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 | |
| - VOID
|
Return |
|
|
ReadASCIILUT |
| - VOID
|
Return |
|
|
SetForegroundColour |
| Specifies the colour of the foreground. | |
| - BYTE
|
R |
| - BYTE
|
G |
| - BYTE
|
B |
| - VOID
|
Return |
|
|
DrawRectangle |
| Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 | |
| - 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. | |
| - VOID
|
Return |
|
|
Initialise |
| The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. | |
| - VOID
|
Return |
|
|
DrawRectangle |
| Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 | |
| - 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. | |
| - VOID
|
Return |
|
|
Initialise |
| The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Embed Font Set |
| Specifies whether or not to add an embedded font set into the program memory. Some displays have their own in-built font set and so do not require an additional embedded font. | |
|
Font |
| Font picker to decide which font to use on your display. | |
|
|
Character Spacing |
| Sets the number of blank pixels between each character when printing text. Default 1. | |
|
|
Space Width |
| Sets the number of horizontal pixels used to represent a space character. | |
|
|
Width Fixed |
| Details if the font has fixed width characters or variable width characters. | |
|
Pixel Width |
| Details the pixel width of the font for fixed width characters. | |
|
|
Pixel Height |
| Details the pixel height of the font. | |
|
|
First Character |
| Details the first printable ASCI character. | |
|
|
Character Count |
| Details the number of characters available, different fonts may have different characters available. | |
|
|
Bytes Per Column |
|
Connections |
|
|
Simulations |
