Jump to content

Component: GLCD (EBM001) (EBM Modules): Difference between revisions

From Flowcode Help
XML import
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix Ltd
| Matrix Ltd
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.6 (Release)
| 1.6
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| EBM Modules
| EBM Modules
|}
|}




==GLCD (EBM001) component==
Graphical display component designed to work with the EBM001 modules and EB084 E-blocks. Based on the ILI9163C 16-bit colour graphical controller IC.


==[[File:Component Icon 5a6d2f2e_da92_49b4_ad5c_71f51e8fe24b.png|Image]] GLCD (EBM001) component==
==Version information==
Graphical display component designed to work with the EBM001 modules and EB084 E-blocks.
Based on the ILI9163C 16-bit colour graphical controller IC.


==Examples==
Library Version, Component Version, Date, Author, Info
''<span style="color:red;">No additional examples</span>''
11, 1.0, 22-07-24, BR, Added DrawArc and DrawRoundedRectangle functions


==Detailed description==


==Downloadable macro reference==


===<span style="font-weight: normal;"><u><tt>BacklightOn</tt></u></span>===
Sets the backlight enable pin allowing the display backlight to switch on.


Switching the backlight on and off at high speed allow the light to be dimmed.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>===
This macro prints a decimal number to the Graphical LCD.


'''Parameters'''


:[[Variable Types|INT]] ''Number''
::Byte or Integer number to send to the display.


:[[Variable Types|UINT]] ''X''
::X pixel coordinate to set the output string position.


:[[Variable Types|UINT]] ''Y''
::Y pixel coordinate to set the output string position.


:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes


:[[Variable Types|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''




===<span style="font-weight: normal;"><u><tt>DrawLine</tt></u></span>===
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.


'''Parameters'''


:[[Variable Types|UINT]] ''X1''
''No detailed description exists yet for this component''


:[[Variable Types|UINT]] ''Y1''
==Examples==


:[[Variable Types|UINT]] ''X2''


:[[Variable Types|UINT]] ''Y2''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>Plot</tt></u></span>===
Sets a pixel with the current foreground colour at pixel location X, Y.


'''Parameters'''


:[[Variable Types|UINT]] ''X1''


:[[Variable Types|UINT]] ''Y1''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>DrawEllipse</tt></u></span>===
Draws an ellipse object on the display with the center of the ellipse at the location X,Y


'''Parameters'''


:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle


:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle


:[[Variable Types|UINT]] ''XRadius''
::Radius of the circle on the X axis specified in pixels


:[[Variable Types|UINT]] ''YRadius''
::Radius of the circle on the Y axis specified in pixels


:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only


:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour




'''Return value'''
===EBM001 Basic Example===


:''This call does not return a value''
EBM001 gLCD Example File
{{Fcfile|EBM001_Test.fcfx|EBM001 Example}}
Example should show the following on the display on the panel and on the hardware.


[[File:EBM001.jpg]]


===<span style="font-weight: normal;"><u><tt>SetDisplayOrientation</tt></u></span>===
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.


'''Parameters'''
===EBM001 Maze Builder===
{{Fcfile|Maze_Builder_gLCD.fcfx|Maze Builder gLCD}}
Example to draw a randomly generated 2D maze on an EBM001 graphical display.


:[[Variable Types|BYTE]] ''Orientation''
[[File:MazeBuildGLCD.jpg]]
::0=Default, 1=90°CW, 2=180°CW, 3=270°CW




'''Return value'''


:''This call does not return a value''
===EBM001 Drawing 3D Objects With Perspective===
{{Fcfile|3D_Manipulations.fcfx|3D Manipulations}}
Example should show the following on the display on the panel and on the hardware. The two switches allow you to move closer to or away from the object. The perspective provides more and more distortion to the object the closer you get.


[[File:3DClose.jpg]]


===<span style="font-weight: normal;"><u><tt>BacklightOff</tt></u></span>===
[[File:3DFar.jpg]]
Clears the backlight enable pin allowing the display backlight to switch off.


Switching the backlight on and off at high speed allow the light to be dimmed.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>BPlot</tt></u></span>===
Sets a pixel with the current background colour at pixel location X, Y.


'''Parameters'''


:[[Variable Types|UINT]] ''X1''


:[[Variable Types|UINT]] ''Y1''




'''Return value'''


:''This call does not return a value''


==Macro reference==


===<span style="font-weight: normal;"><u><tt>Print</tt></u></span>===
===BPlot===
This macro prints a string of characters to the Graphical LCD.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''BPlot'''
|-
| colspan="2" | Sets a pixel with the current background colour at pixel location X, Y.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|<- STRING]] ''Str''
===BacklightOff===
::String of characters to send to the display.
{| class="mtx-class-macrotable wikitable"
::''This parameter may be returned back to the caller''
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''BacklightOff'''
|-
| colspan="2" | Clears the backlight enable pin allowing the display backlight to switch off. Switching the backlight on and off at high speed allow the light to be dimmed.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|UINT]] ''X1''
::X pixel coordinate to set the output string position.


:[[Variable Types|UINT]] ''Y1''
===BacklightOn===
::Y pixel coordinate to set the output string position.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''BacklightOn'''
|-
| colspan="2" | Sets the backlight enable pin allowing the display backlight to switch on. Switching the backlight on and off at high speed allow the light to be dimmed.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes


:[[Variable Types|BYTE]] ''Transparent''
===ClearDisplay===
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ClearDisplay'''
|-
| colspan="2" | This macro clears the display of any previous output by overwriting the entire display with the background colour.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===DrawArc===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DrawArc'''
|-
| colspan="2" | Draws an arc either as an outline or as a filled object.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | Center X coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Center Y coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Radius
|-
| colspan="2" | Radius, distance of edge from the centre coordinates&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | StartAngle
|-
| colspan="2" | Angle to start drawing, in degrees&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | EndAngle
|-
| colspan="2" | Angle to end drawing, in degrees&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Resolution
|-
| colspan="2" | Number of lines to draw from the center to the outer edge, 0=Fill&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Transparent
|-
| colspan="2" | Chooses the transparency - 0 = Arc contains background colour, 1 = Arc contains previous pixel data.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Solid
|-
| colspan="2" | Chooses to fill with colour - 0 = Arc transparency data, 1 = Arc contains foreground colour.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This call does not return a value''


===DrawBezier===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DrawBezier'''
|-
| colspan="2" | Draws a quadratic Bezier curve with the current foreground colour from pixel location X0, Y0 to pixel location X2, Y2 using control point CX, CY.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X0
|-
| colspan="2" | Start X coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y0
|-
| colspan="2" | Start Y coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CX
|-
| colspan="2" | Control point X coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CY
|-
| colspan="2" | Control point Y coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X2
|-
| colspan="2" | End X coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y2
|-
| colspan="2" | End Y coordinate&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Resolution
|-
| colspan="2" | Number of segments to approximate the curve, 0 chooses an automatic value based on curve size.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>ClearDisplay</tt></u></span>===
This macro clears the display of any previous output by overwriting the entire display with the background colour.


'''Parameters'''
===DrawCircle===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DrawCircle'''
|-
| colspan="2" | Draws a circle object on the display with the center of the circle at the location X,Y&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Coordinate for the center of the circle&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y coordinate for the center of the circle&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Radius
|-
| colspan="2" | Radius of the circle specified in pixels&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Transparent
|-
| colspan="2" | 0=Fill inside circle using background colour / 1=Draw outer circle only&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Solid
|-
| colspan="2" | 0=Use Transparent Setting / 1=Fill with foreground colour&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This macro has no parameters''


===DrawEllipse===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DrawEllipse'''
|-
| colspan="2" | Draws an ellipse object on the display with the center of the ellipse at the location X,Y&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Coordinate for the center of the circle&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y coordinate for the center of the circle&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | XRadius
|-
| colspan="2" | Radius of the circle on the X axis specified in pixels&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | YRadius
|-
| colspan="2" | Radius of the circle on the Y axis specified in pixels&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Transparent
|-
| colspan="2" | 0=Fill inside circle using background colour / 1=Draw outer circle only&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Solid
|-
| colspan="2" | 0=Use Transparent Setting / 1=Fill with foreground colour&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:''This call does not return a value''
===DrawLine===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DrawLine'''
|-
| colspan="2" | Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>SetBackgroundColour</tt></u></span>===
===DrawRectangle===
Specifies the colour of the background by creating a mixture of red, green and blue.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DrawRectangle'''
|-
| colspan="2" | Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Transparent
|-
| colspan="2" | Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Solid
|-
| colspan="2" | Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|BYTE]] ''Red''
===DrawRoundedRectangle===
::0 - 255 where 0 = no red and 255 = maximum red
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DrawRoundedRectangle'''
|-
| colspan="2" | Draws a rectangle with rounded corners&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Radius
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Transparent
|-
| colspan="2" | Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Solid
|-
| colspan="2" | Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Green''
::0 - 255 where 0 = no green and 255 = maximum green


:[[Variable Types|BYTE]] ''Blue''
===FastPlot===
::0 - 255 where 0 = no blue and 255 = maximum blue
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''FastPlot'''
|-
| colspan="2" | Sets a pixel with the current foreground colour at current pixel location. Not compatible with orientations other than 0.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===Initialise===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Initialise'''
|-
| colspan="2" | The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This call does not return a value''


===Plot===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Plot'''
|-
| colspan="2" | Sets a pixel with the current foreground colour at pixel location X, Y.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>DrawCircle</tt></u></span>===
Draws a circle object on the display with the center of the circle at the location X,Y


'''Parameters'''
===Print===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Print'''
|-
| colspan="2" | This macro prints a string of characters to the Graphical LCD.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Str
|-
| colspan="2" | String of characters to send to the display.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X1
|-
| colspan="2" | X pixel coordinate to set the output string position.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y1
|-
| colspan="2" | Y pixel coordinate to set the output string position.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | Selects which Font to use Range: 0 to Font Count&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Transparent
|-
| colspan="2" | Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle


:[[Variable Types|UINT]] ''Y''
===PrintNumber===
::Y coordinate for the center of the circle
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''PrintNumber'''
|-
| colspan="2" | This macro prints a decimal number to the Graphical LCD.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Number
|-
| colspan="2" | Byte or Integer number to send to the display.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X pixel coordinate to set the output string position.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y pixel coordinate to set the output string position.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Transparent
|-
| colspan="2" | Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|UINT]] ''Radius''
::Radius of the circle specified in pixels


:[[Variable Types|BYTE]] ''Transparent''
===ReadFontStat===
::0=Fill inside circle using background colour / 1=Draw outer circle only
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadFontStat'''
|-
| colspan="2" | Gets a stat from the selected embedded ASCII font data.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | Font selection range: 0 to (NumFonts - 1)&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | 0=SpaceWidth, 1=PixelHeight&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour


===ReadFontWidth===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadFontWidth'''
|-
| colspan="2" | Reads the number of pixel columns used in the selected font&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | Font selection range: 0 to (NumFonts - 1)&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Character
|-
| colspan="2" | ASCII character to get the pixel width e.g. 'A' or 65&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:''This call does not return a value''
===SetBackgroundColour===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetBackgroundColour'''
|-
| colspan="2" | Specifies the colour of the background by creating a mixture of red, green and blue. &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Red
|-
| colspan="2" | 0 - 255 where 0 = no red and 255 = maximum red&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Green
|-
| colspan="2" | 0 - 255 where 0 = no green and 255 = maximum green&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Blue
|-
| colspan="2" | 0 - 255 where 0 = no blue and 255 = maximum blue&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>SetForegroundColour</tt></u></span>===
===SetDisplayOrientation===
Specifies the colour of the foreground by creating a mixture of red, green and blue.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetDisplayOrientation'''
|-
| colspan="2" | Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Orientation
|-
| colspan="2" | 0=Default, 1=90°CW, 2=180°CW, 3=270°CW&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|BYTE]] ''Red''
===SetFontScaler===
::0 - 255 where 0 = no red and 255 = maximum red
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetFontScaler'''
|-
| colspan="2" | Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ScaleX
|-
| colspan="2" | Sets the horizontal scale of the font, default 1&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ScaleY
|-
| colspan="2" | Sets the vertical scale of the font, default 1&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Green''
::0 - 255 where 0 = no green and 255 = maximum green


:[[Variable Types|BYTE]] ''Blue''
===SetForegroundColour===
::0 - 255 where 0 = no blue and 255 = maximum blue
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetForegroundColour'''
|-
| colspan="2" | Specifies the colour of the foreground by creating a mixture of red, green and blue. &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Red
|-
| colspan="2" | 0 - 255 where 0 = no red and 255 = maximum red&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Green
|-
| colspan="2" | 0 - 255 where 0 = no green and 255 = maximum green&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Blue
|-
| colspan="2" | 0 - 255 where 0 = no blue and 255 = maximum blue&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===Window===
 
{| class="mtx-class-macrotable wikitable"
:''This call does not return a value''
|-
 
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Window'''
===<span style="font-weight: normal;"><u><tt>DrawRectangle</tt></u></span>===
|-
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
| colspan="2" | Specifies a full screen or sub window of pixels to draw. Useful when used with the FastPlot function to draw bitmaps at high speed.&nbsp;
 
|-
'''Parameters'''
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
:[[Variable Types|UINT]] ''X1''
| width="90%" | X1
 
|-
:[[Variable Types|UINT]] ''Y1''
| colspan="2" | &nbsp;
 
|-
:[[Variable Types|UINT]] ''X2''
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" | Y1
:[[Variable Types|UINT]] ''Y2''
|-
 
| colspan="2" | &nbsp;
:[[Variable Types|BYTE]] ''Transparent''
|-
::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" | X2
:[[Variable Types|BYTE]] ''Solid''
|-
::Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
| colspan="2" | &nbsp;
 
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
'''Return value'''
| width="90%" | Y2
 
|-
:''This call does not return a value''
| colspan="2" | &nbsp;
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
| width="90%" style="border-top: 2px solid #000;" | ''Return''
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''
 
 
 
==Simulation macro reference==
 
''This component does not contain any simulation macros''




==Property reference==
==Property reference==
<span style="font-weight: normal;"><u>Pixel Height</u></span>


This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''.
{| class="mtx-class-macrotable wikitable"
 
|-
Heigt of gLCD canvas measured in pixels.
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
<span style="font-weight: normal;"><u>Pixel Width</u></span>
|-
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Dimensions
Width of gLCD canvas measured in pixels.
|-
 
|-
<span style="font-weight: normal;"><u>Monochrome</u></span>
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Pixel Width
This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.
|-
 
| colspan="2" | Width of gLCD canvas measured in pixels.&nbsp;
Specifies if the display is capable of colour or monochrome only.
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
<span style="font-weight: normal;"><u>Foreground Color</u></span>
| width="90%" | Pixel Height
 
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.
| colspan="2" | Heigt of gLCD canvas measured in pixels.&nbsp;
 
|-
Specifies the initial foreground color.
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Colour
<span style="font-weight: normal;"><u>Background Color</u></span>
|-
 
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Monochrome
Specifies the initial background color.
|-
 
| colspan="2" | Specifies if the display is capable of colour or monochrome only.&nbsp;
<span style="font-weight: normal;"><u>Colour Bit Depth</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.
| width="90%" | Foreground Color
 
|-
Total color bit depth for the display.
| colspan="2" | Specifies the initial foreground color.&nbsp;
 
|-
<span style="font-weight: normal;"><u>Red Bit Depth</u></span>
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
| width="90%" | Background Color
This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.
|-
 
| colspan="2" | Specifies the initial background color.&nbsp;
Specifies the red bit depth for the display.
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>Green Bit Depth</u></span>
| width="90%" class="mtx-class-propfolder" | Bit Depth
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
Specifies the green bit depth for the display.
| width="90%" | Colour Bit Depth
 
|-
<span style="font-weight: normal;"><u>Blue Bit Depth</u></span>
| colspan="2" | Total color bit depth for the display.&nbsp;
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Red Bit Depth
Specifies the blue bit depth for the display.
|-
 
| colspan="2" | Specifies the red bit depth for the display.&nbsp;
<span style="font-weight: normal;"><u>Data</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
This property is of type ''Single digital pin'' and can be referenced with the variable name ''data_pin''.
| width="90%" | Green Bit Depth
 
|-
Data pin connection
| colspan="2" | Specifies the green bit depth for the display.&nbsp;
 
|-
<span style="font-weight: normal;"><u>Clock</u></span>
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Blue Bit Depth
This property is of type ''Single digital pin'' and can be referenced with the variable name ''clock_pin''.
|-
 
| colspan="2" | Specifies the blue bit depth for the display.&nbsp;
Clock pin connection
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>Chip Select</u></span>
| width="90%" class="mtx-class-propfolder" | Connections
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''chip_sel_pin''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
Chip select pin connection
| width="90%" | Data
 
|-
<span style="font-weight: normal;"><u>A0</u></span>
| colspan="2" | Data pin connection&nbsp;
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''a0_pin''.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | Clock
Instruction / Command pin connection
|-
 
| colspan="2" | Clock pin connection&nbsp;
<span style="font-weight: normal;"><u>Reset</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
This property is of type ''Single digital pin'' and can be referenced with the variable name ''reset_pin''.
| width="90%" | Chip Select
 
|-
Reset pin connection
| colspan="2" | Chip select pin connection&nbsp;
 
|-
<span style="font-weight: normal;"><u>LED</u></span>
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | A0
This property is of type ''Single digital pin'' and can be referenced with the variable name ''led_pin''.
|-
 
| colspan="2" | Instruction / Command pin connection&nbsp;
LED backlight strobe pin connection
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
<span style="font-weight: normal;"><u>Display Method</u></span>
| width="90%" | Reset
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.
| colspan="2" | Reset pin connection&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | LED
|-
| colspan="2" | LED backlight strobe pin connection&nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Fonts
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Font Count
|-
| colspan="2" | Specifies the number of fonts available to use on the display.&nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Font 0
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bytes Required
|-
| colspan="2" | Number of bytes required in program memory to store the selected font.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Character Spacing
|-
| colspan="2" | Sets the number of blank pixels between each character when printing text.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Space Width
|-
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Component Label
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Component Label Scale
|-
| colspan="2" | The label scale can be change if the amout of text is too wide for the display &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Physical Orientation
|-
| colspan="2" | Rotates the simulated canvas to match the orientation of real world hardware.&nbsp;
|}


Chooses which method to use when drawing to the gLCD component
==Component Source Code==


The bitmap is the more common mode but may run slowly on some machines.
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_GLCD_EBM001.fcfx FC_Comp_Source_GLCD_EBM001.fcfx]


The point cloud should run faster but may use more memory.
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_GLCD_EBM001.fcfx FC_Comp_Source_GLCD_EBM001.fcfx]

Latest revision as of 14:36, 13 July 2026

Author Matrix Ltd
Version 1.6
Category EBM Modules


GLCD (EBM001) component

Graphical display component designed to work with the EBM001 modules and EB084 E-blocks. Based on the ILI9163C 16-bit colour graphical controller IC.

Version information

Library Version, Component Version, Date, Author, Info
11, 1.0, 22-07-24, BR, Added DrawArc and DrawRoundedRectangle functions

Detailed description

No detailed description exists yet for this component

Examples

EBM001 Basic Example

EBM001 gLCD Example File EBM001 Example Example should show the following on the display on the panel and on the hardware.


EBM001 Maze Builder

Maze Builder gLCD Example to draw a randomly generated 2D maze on an EBM001 graphical display.


EBM001 Drawing 3D Objects With Perspective

3D Manipulations Example should show the following on the display on the panel and on the hardware. The two switches allow you to move closer to or away from the object. The perspective provides more and more distortion to the object the closer you get.








Macro reference

BPlot

BPlot
Sets a pixel with the current background colour at pixel location X, Y. 
- UINT X1
 
- UINT Y1
 
- VOID Return


BacklightOff

BacklightOff
Clears the backlight enable pin allowing the display backlight to switch off. Switching the backlight on and off at high speed allow the light to be dimmed. 
- VOID Return


BacklightOn

BacklightOn
Sets the backlight enable pin allowing the display backlight to switch on. Switching the backlight on and off at high speed allow the light to be dimmed. 
- VOID Return


ClearDisplay

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


DrawArc

DrawArc
Draws an arc either as an outline or as a filled object. 
- UINT X
Center X coordinate 
- UINT Y
Center Y coordinate 
- UINT Radius
Radius, distance of edge from the centre coordinates 
- FLOAT StartAngle
Angle to start drawing, in degrees 
- FLOAT EndAngle
Angle to end drawing, in degrees 
- UINT Resolution
Number of lines to draw from the center to the outer edge, 0=Fill 
- BYTE Transparent
Chooses the transparency - 0 = Arc contains background colour, 1 = Arc contains previous pixel data. 
- BYTE Solid
Chooses to fill with colour - 0 = Arc transparency data, 1 = Arc contains foreground colour. 
- VOID Return


DrawBezier

DrawBezier
Draws a quadratic Bezier curve with the current foreground colour from pixel location X0, Y0 to pixel location X2, Y2 using control point CX, CY. 
- UINT X0
Start X coordinate 
- UINT Y0
Start Y coordinate 
- UINT CX
Control point X coordinate 
- UINT CY
Control point Y coordinate 
- UINT X2
End X coordinate 
- UINT Y2
End Y coordinate 
- UINT Resolution
Number of segments to approximate the curve, 0 chooses an automatic value based on curve size. 
- VOID Return


DrawCircle

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


DrawEllipse

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


DrawLine

DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. 
- UINT X1
 
- UINT Y1
 
- UINT X2
 
- UINT Y2
 
- VOID Return


DrawRectangle

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


DrawRoundedRectangle

DrawRoundedRectangle
Draws a rectangle with rounded corners 
- UINT X1
 
- UINT Y1
 
- UINT X2
 
- UINT Y2
 
- UINT Radius
 
- 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


FastPlot

FastPlot
Sets a pixel with the current foreground colour at current pixel location. Not compatible with orientations other than 0. 
- VOID Return


Initialise

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


Plot

Plot
Sets a pixel with the current foreground colour at pixel location X, Y. 
- UINT X1
 
- UINT Y1
 
- VOID Return


Print

Print
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
Selects which Font to use Range: 0 to Font Count 
- BYTE Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. 
- VOID Return


PrintNumber

PrintNumber
This macro prints a decimal number to the Graphical LCD. 
- 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
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


ReadFontStat

ReadFontStat
Gets a stat from the selected embedded ASCII font data. 
- BYTE Font
Font selection range: 0 to (NumFonts - 1) 
- BYTE Index
0=SpaceWidth, 1=PixelHeight 
- BYTE Return


ReadFontWidth

ReadFontWidth
Reads the number of pixel columns used in the selected font 
- BYTE Font
Font selection range: 0 to (NumFonts - 1) 
- BYTE Character
ASCII character to get the pixel width e.g. 'A' or 65 
- BYTE Return


SetBackgroundColour

SetBackgroundColour
Specifies the colour of the background by creating a mixture of red, green and blue.  
- 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 
- VOID Return


SetDisplayOrientation

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


SetFontScaler

SetFontScaler
Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y. 
- BYTE ScaleX
Sets the horizontal scale of the font, default 1 
- BYTE ScaleY
Sets the vertical scale of the font, default 1 
- VOID Return


SetForegroundColour

SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.  
- 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 
- VOID Return


Window

Window
Specifies a full screen or sub window of pixels to draw. Useful when used with the FastPlot function to draw bitmaps at high speed. 
- UINT X1
 
- UINT Y1
 
- UINT X2
 
- UINT Y2
 
- VOID Return


Property reference

Properties
Dimensions
Pixel Width
Width of gLCD canvas measured in pixels. 
Pixel Height
Heigt of gLCD canvas measured in pixels. 
Colour
Monochrome
Specifies if the display is capable of colour or monochrome only. 
Foreground Color
Specifies the initial foreground color. 
Background Color
Specifies the initial background color. 
Bit Depth
Colour Bit Depth
Total color bit depth for the display. 
Red Bit Depth
Specifies the red bit depth for the display. 
Green Bit Depth
Specifies the green bit depth for the display. 
Blue Bit Depth
Specifies the blue bit depth for the display. 
Connections
Data
Data pin connection 
Clock
Clock pin connection 
Chip Select
Chip select pin connection 
A0
Instruction / Command pin connection 
Reset
Reset pin connection 
LED
LED backlight strobe pin connection 
Fonts
Font Count
Specifies the number of fonts available to use on the display. 
Font 0
Font
Font picker to decide which font to use on your display. 
Bytes Required
Number of bytes required in program memory to store the selected font. 
Character Spacing
Sets the number of blank pixels between each character when printing text. 
Space Width
Sets the number of horizontal pixels used to represent a space character. 
Simulation
Component Label
 
Component Label Scale
The label scale can be change if the amout of text is too wide for the display  
Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware. 

Component Source Code

Please click here to download the component source project: FC_Comp_Source_GLCD_EBM001.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_GLCD_EBM001.fcfx