Difference between revisions of "Component: GLCD (ST7789V) (Graphical Color)"

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| width="50%" |- | width="20%" style="color: gray;" | Author | Matrix Ltd |- | width="20%" style="color: gray;" | Version | 1.6 (Release) |- | width="20%" style="color: gray;...")
 
Line 1: Line 1:
−
{| width="50%"
+
{| style="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
 
| Graphical Color
 
| Graphical Color
 
|}
 
|}
  
  
−
 
+
==GLCD (ST7789V) component==
−
==[[File:Component Icon 4e30b15e_2507_4583_995d_b2056e04a286.png|Image]] GLCD (ST7789V) component==
 
 
Graphical display component designed to work with the ST7789V 16-bit colour graphical controller IC.
 
Graphical display component designed to work with the ST7789V 16-bit colour graphical controller IC.
  
−
==Examples==
+
==Detailed description==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
''No detailed description exists yet for this component''
  
−
==Downloadable macro reference==
+
==Examples==
  
−
===<span style="font-weight: normal;"><u><tt>ReadFontWidth</tt></u></span>===
 
−
Reads the number of pixel columns used in the selected font
 
  
−
'''Parameters'''
+
''<span style="color:red;">No additional examples</span>''
  
−
:[[Variable Types|BYTE]] ''Font''
 
−
::Font selection range: 0 to (NumFonts - 1)
 
  
−
:[[Variable Types|BYTE]] ''Character''
+
==Downloadable macro reference==
−
::ASCII character to get the pixel width e.g. 'A' or 65
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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'''
 
  
−
:[[Variable Types|BYTE]]
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BacklightOn'''
 +
|-
 +
| colspan="2" | Switches on the backlight&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>BacklightOn</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Switches on the backlight
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintNumber'''
 +
|-
 +
| colspan="2" | This macro prints a decimal number to the Graphical LCD.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| 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''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
:''This call does not return a value''
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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>PrintNumber</tt></u></span>===
 
−
This macro prints a decimal number to the Graphical LCD.
 
  
−
'''Parameters'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
:[[Variable Types|INT]] ''Number''
 
−
::Byte or Integer number to send to the display.
 
  
−
:[[Variable Types|UINT]] ''X''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::X pixel coordinate to set the output string position.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
:[[Variable Types|UINT]] ''Y''
 
−
::Y pixel coordinate to set the output string position.
 
  
−
:[[Variable Types|BYTE]] ''Font''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''Transparent''
 
−
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BacklightOff'''
 +
|-
 +
| colspan="2" | Switches off the backlight&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''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>DrawLine</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Window'''
 +
|-
 +
| 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;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''X1''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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|UINT]] ''Y1''
 
  
−
:[[Variable Types|UINT]] ''X2''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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]] ''Y2''
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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'''
 
  
−
:''This call does not return a value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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>Plot</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Sets a pixel with the current foreground colour at pixel location X, Y.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''X1''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
:[[Variable Types|UINT]] ''Y1''
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
===<span style="font-weight: normal;"><u><tt>DrawEllipse</tt></u></span>===
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
−
Draws an ellipse object on the display with the center of the ellipse at the location X,Y
+
|-
−
 
+
| 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;
−
'''Parameters'''
+
|-
−
 
+
|-
−
:[[Variable Types|UINT]] ''X''
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
::X Coordinate for the center of the circle
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
 
+
|}
−
:[[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'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>FastPlot</tt></u></span>===
 
−
Sets a pixel with the current foreground colour at current pixel location.
 
−
 
 
−
Not compatible with orientations other than 0.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<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'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Orientation''
 
−
::0=Default, 1=90°CW, 2=180°CW, 3=270°CW
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>BacklightOff</tt></u></span>===
 
−
Switches off the backlight
 
−
 
 
−
'''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''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Window</tt></u></span>===
 
−
Specifies a full screen or sub window of pixels to draw.
 
−
 
 
−
Useful when used with the FastPlot function to draw bitmaps at high speed.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''X1''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Y1''
 
−
 
 
−
:[[Variable Types|BYTE]] ''X2''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Y2''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>ReadFontStat</tt></u></span>===
 
−
Gets a stat from the selected embedded ASCII font data.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Font''
 
−
::Font selection range: 0 to (NumFonts - 1)
 
−
 
 
−
:[[Variable Types|BYTE]] ''Index''
 
−
::0=SpaceWidth, 1=PixelHeight
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:[[Variable Types|BYTE]]
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Print</tt></u></span>===
 
−
This macro prints a string of characters to the Graphical LCD.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|<- STRING]] ''Str''
 
−
::String of characters to send to the display.
 
−
::''This parameter may be returned back to the caller''
 
−
 
 
−
:[[Variable Types|UINT]] ''X1''
 
−
::X pixel coordinate to set the output string position.
 
−
 
 
−
:[[Variable Types|UINT]] ''Y1''
 
−
::Y pixel coordinate to set the output string position.
 
−
 
 
−
:[[Variable Types|BYTE]] ''Font''
 
−
::Selects which Font to use Range: 0 to Font Count
 
−
 
 
−
:[[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>ClearDisplay</tt></u></span>===
 
−
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''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetBackgroundColour</tt></u></span>===
 
−
Specifies the colour of the background by creating a mixture of red, green and blue.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Red''
 
−
::0 - 255 where 0 = no red and 255 = maximum red
 
−
 
 
−
:[[Variable Types|BYTE]] ''Green''
 
−
::0 - 255 where 0 = no green and 255 = maximum green
 
−
 
 
−
:[[Variable Types|BYTE]] ''Blue''
 
−
::0 - 255 where 0 = no blue and 255 = maximum blue
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<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'''
 
−
 
 
−
:[[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]] ''Radius''
 
−
::Radius of the circle 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'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetForegroundColour</tt></u></span>===
 
−
Specifies the colour of the foreground by creating a mixture of red, green and blue.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Red''
 
−
::0 - 255 where 0 = no red and 255 = maximum red
 
−
 
 
−
:[[Variable Types|BYTE]] ''Green''
 
−
::0 - 255 where 0 = no green and 255 = maximum green
 
−
 
 
−
:[[Variable Types|BYTE]] ''Blue''
 
−
::0 - 255 where 0 = no blue and 255 = maximum blue
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<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
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|UINT]] ''X1''
 
−
 
 
−
:[[Variable Types|UINT]] ''Y1''
 
−
 
 
−
:[[Variable Types|UINT]] ''X2''
 
−
 
 
−
:[[Variable Types|UINT]] ''Y2''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Transparent''
 
−
::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
 
−
 
 
−
:[[Variable Types|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''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
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 Width</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Width of gLCD canvas measured in pixels.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<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''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Pixel Width
−
Heigt of gLCD canvas measured in pixels.
+
|-
−
 
+
| colspan="2" | Width of gLCD canvas measured in pixels.&nbsp;
−
<span style="font-weight: normal;"><u>X Offset</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''XOffset''.
+
| width="90%" | Pixel Height
−
 
+
|-
−
Horizontal offset before the active display pixels.
+
| colspan="2" | Heigt of gLCD canvas measured in pixels.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Y Offset</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | X Offset
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''YOffset''.
+
|-
−
 
+
| colspan="2" | Horizontal offset before the active display pixels.&nbsp;
−
Vertical offset before the active display pixels.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
<span style="font-weight: normal;"><u>Monochrome</u></span>
+
| width="90%" | Y Offset
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.
+
| colspan="2" | Vertical offset before the active display pixels.&nbsp;
−
 
+
|-
−
Specifies if the display is capable of colour or monochrome only.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Monochrome
−
<span style="font-weight: normal;"><u>Foreground Color</u></span>
+
|-
−
 
+
| colspan="2" | Specifies if the display is capable of colour or monochrome only.&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
Specifies the initial foreground color.
+
| width="90%" | Foreground Color
−
 
+
|-
−
<span style="font-weight: normal;"><u>Background Color</u></span>
+
| colspan="2" | Specifies the initial foreground color.&nbsp;
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Background Color
−
Specifies the initial background color.
+
|-
−
 
+
| colspan="2" | Specifies the initial background color.&nbsp;
−
<span style="font-weight: normal;"><u>Invert Colours</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''InvColours''.
+
| width="90%" | Invert Colours
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Colour Bit Depth
−
<span style="font-weight: normal;"><u>Colour 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 ''colour_bit_depth''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Total color bit depth for the display.
+
| width="90%" | Red Bit Depth
−
 
+
|-
−
<span style="font-weight: normal;"><u>Red Bit Depth</u></span>
+
| colspan="2" | Specifies the red bit depth for the display.&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Green Bit Depth
−
Specifies the red bit depth for the display.
+
|-
−
 
+
| colspan="2" | Specifies the green bit depth for the display.&nbsp;
−
<span style="font-weight: normal;"><u>Green Bit Depth</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.
+
| width="90%" | Blue Bit Depth
−
 
+
|-
−
Specifies the green bit depth for the display.
+
| colspan="2" | Specifies the blue bit depth for the display.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Blue Bit Depth</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Font Count
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.
+
|-
−
 
+
| colspan="2" | Specifies the number of fonts available to use on the display.&nbsp;
−
Specifies the blue bit depth for the display.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Data</u></span>
+
| width="90%" | Font
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''data_pin''.
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
 
+
|-
−
Data pin connection
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Character Spacing
−
<span style="font-weight: normal;"><u>Clock</u></span>
+
|-
−
 
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''clock_pin''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Clock pin connection
+
| width="90%" | Space Width
−
 
+
|-
−
<span style="font-weight: normal;"><u>Chip Select</u></span>
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
 
+
|-
−
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-16-icon.png]]
−
 
+
| width="90%" | Font
−
Chip select pin connection
+
|-
−
 
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
<span style="font-weight: normal;"><u>Reset</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''ResetPin''.
+
| width="90%" | Character Spacing
−
 
+
|-
−
Reset Pin
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Backlight</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Space Width
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''BacklightPin''.
+
|-
−
 
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
Backlight Pin
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Use DC Pin</u></span>
+
| width="90%" | Font
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''UseDC''.
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Character Spacing
−
 
+
|-
−
 
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
<span style="font-weight: normal;"><u>DC</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''DCPin''.
+
| width="90%" | Space Width
−
 
+
|-
−
Data/Command Pin
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Font Count</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Font
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::FontCount''.
+
|-
−
 
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
Specifies the number of fonts available to use on the display.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Font</u></span>
+
| width="90%" | Character Spacing
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font1::Font''.
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
 
+
|-
−
Font picker to decide which font to use on your display.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Space Width
−
<span style="font-weight: normal;"><u>Character Spacing</u></span>
+
|-
−
 
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font1::FontSpace''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Sets the number of blank pixels between each character when printing text.
+
| width="90%" | Display Method
−
 
+
|-
−
Default 1.
+
| colspan="2" | 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. &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Space Width</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font1::SpaceWidth''.
+
|-
−
 
+
|-
−
Sets the number of horizontal pixels used to represent a space character.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Data
−
<span style="font-weight: normal;"><u>Font</u></span>
+
|-
−
 
+
| colspan="2" | Data pin connection&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font2::Font''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
Font picker to decide which font to use on your display.
+
| width="90%" | Clock
−
 
+
|-
−
<span style="font-weight: normal;"><u>Character Spacing</u></span>
+
| colspan="2" | Clock pin connection&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font2::FontSpace''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Use CS
−
Sets the number of blank pixels between each character when printing text.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
Default 1.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Space Width</u></span>
+
| width="90%" | Toggle CS
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font2::SpaceWidth''.
+
| colspan="2" | Selects if the chip select pin is automatically toggled or left selected. Yes - Slightly slower but allows pins to be multiplexed with other devices. No - Slightly faster.&nbsp;
−
 
+
|-
−
Sets the number of horizontal pixels used to represent a space character.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Chip Select
−
<span style="font-weight: normal;"><u>Font</u></span>
+
|-
−
 
+
| colspan="2" | Chip select pin connection&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font3::Font''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Font picker to decide which font to use on your display.
+
| width="90%" | Use Reset
−
 
+
|-
−
<span style="font-weight: normal;"><u>Character Spacing</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font3::FontSpace''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Reset
−
Sets the number of blank pixels between each character when printing text.
+
|-
−
 
+
| colspan="2" | Reset Pin&nbsp;
−
Default 1.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Space Width</u></span>
+
| width="90%" | Use Backlight
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font3::SpaceWidth''.
+
| colspan="2" | &nbsp;
−
 
+
|-
−
Sets the number of horizontal pixels used to represent a space character.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Backlight
−
<span style="font-weight: normal;"><u>Font</u></span>
+
|-
−
 
+
| colspan="2" | Backlight Pin&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font4::Font''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Font picker to decide which font to use on your display.
+
| width="90%" | Use DC Pin
−
 
+
|-
−
<span style="font-weight: normal;"><u>Character Spacing</u></span>
+
| colspan="2" | Selects if the DC pins is available, Yes we use the DC pin to control if a data or commnd is being sent. No we add an extra bit to the data to do the job of the DC pin.&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font4::FontSpace''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | DC
−
Sets the number of blank pixels between each character when printing text.
+
|-
−
 
+
| colspan="2" | Data/Command Pin&nbsp;
−
Default 1.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>Space Width</u></span>
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Base_GLCD::gLCD_Font4::SpaceWidth''.
+
|}
−
 
 
−
Sets the number of horizontal pixels used to represent a space character.
 
−
 
 
−
<span style="font-weight: normal;"><u>Display Method</u></span>
 
−
 
 
−
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.
 

Revision as of 21:03, 16 November 2021

Author Matrix Ltd
Version 1.6
Category Graphical Color


GLCD (ST7789V) component

Graphical display component designed to work with the ST7789V 16-bit colour graphical controller IC.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

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


Fc9-comp-macro.png BacklightOn
Switches on the backlight 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png PrintNumber
This macro prints a decimal number to the Graphical LCD. 
[[File:]] - Number
Byte or Integer number to send to the display. 
Fc9-u16-icon.png - UINT X
X pixel coordinate to set the output string position. 
Fc9-u16-icon.png - UINT Y
Y pixel coordinate to set the output string position. 
Fc9-u8-icon.png - BYTE Font
Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes 
Fc9-u8-icon.png - BYTE Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Plot
Sets a pixel with the current foreground colour at pixel location X, Y. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawEllipse
Draws an ellipse object on the display with the center of the ellipse at the location X,Y 
Fc9-u16-icon.png - UINT X
X Coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Y
Y coordinate for the center of the circle 
Fc9-u16-icon.png - UINT XRadius
Radius of the circle on the X axis specified in pixels 
Fc9-u16-icon.png - UINT YRadius
Radius of the circle on the Y axis specified in pixels 
Fc9-u8-icon.png - BYTE Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only 
Fc9-u8-icon.png - BYTE Solid
0=Use Transparent Setting / 1=Fill with foreground colour 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FastPlot
Sets a pixel with the current foreground colour at current pixel location. Not compatible with orientations other than 0. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisplayOrientation
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. 
Fc9-u8-icon.png - BYTE Orientation
0=Default, 1=90°CW, 2=180°CW, 3=270°CW 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png BacklightOff
Switches off the backlight 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png BPlot
Sets a pixel with the current background colour at pixel location X, Y. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png Print
This macro prints a string of characters to the Graphical LCD. 
Fc9-string-icon.png - STRING Str
String of characters to send to the display. 
Fc9-u16-icon.png - UINT X1
X pixel coordinate to set the output string position. 
Fc9-u16-icon.png - UINT Y1
Y pixel coordinate to set the output string position. 
Fc9-u8-icon.png - BYTE Font
Selects which Font to use Range: 0 to Font Count 
Fc9-u8-icon.png - BYTE Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png SetBackgroundColour
Specifies the colour of the background by creating a mixture of red, green and blue.  
Fc9-u8-icon.png - BYTE Red
0 - 255 where 0 = no red and 255 = maximum red 
Fc9-u8-icon.png - BYTE Green
0 - 255 where 0 = no green and 255 = maximum green 
Fc9-u8-icon.png - BYTE Blue
0 - 255 where 0 = no blue and 255 = maximum blue 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y 
Fc9-u16-icon.png - UINT X
X Coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Y
Y coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Radius
Radius of the circle specified in pixels 
Fc9-u8-icon.png - BYTE Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only 
Fc9-u8-icon.png - BYTE Solid
0=Use Transparent Setting / 1=Fill with foreground colour 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.  
Fc9-u8-icon.png - BYTE Red
0 - 255 where 0 = no red and 255 = maximum red 
Fc9-u8-icon.png - BYTE Green
0 - 255 where 0 = no green and 255 = maximum green 
Fc9-u8-icon.png - BYTE Blue
0 - 255 where 0 = no blue and 255 = maximum blue 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-u8-icon.png - BYTE Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. 
Fc9-u8-icon.png - BYTE Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-14-icon.png Pixel Width
Width of gLCD canvas measured in pixels. 
Fc9-type-14-icon.png Pixel Height
Heigt of gLCD canvas measured in pixels. 
Fc9-type-21-icon.png X Offset
Horizontal offset before the active display pixels. 
Fc9-type-21-icon.png Y Offset
Vertical offset before the active display pixels. 
Fc9-type-7-icon.png Monochrome
Specifies if the display is capable of colour or monochrome only. 
Fc9-type-1-icon.png Foreground Color
Specifies the initial foreground color. 
Fc9-type-1-icon.png Background Color
Specifies the initial background color. 
Fc9-type-7-icon.png Invert Colours
 
Fc9-type-14-icon.png Colour Bit Depth
Total color bit depth for the display. 
Fc9-type-14-icon.png Red Bit Depth
Specifies the red bit depth for the display. 
Fc9-type-14-icon.png Green Bit Depth
Specifies the green bit depth for the display. 
Fc9-type-14-icon.png Blue Bit Depth
Specifies the blue bit depth for the display. 
Fc9-type-16-icon.png Font Count
Specifies the number of fonts available to use on the display. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Display Method
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.  
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Data
Data pin connection 
Fc9-type-5-icon.png Clock
Clock pin connection 
Fc9-type-7-icon.png Use CS
 
Fc9-type-7-icon.png Toggle CS
Selects if the chip select pin is automatically toggled or left selected. Yes - Slightly slower but allows pins to be multiplexed with other devices. No - Slightly faster. 
Fc9-type-5-icon.png Chip Select
Chip select pin connection 
Fc9-type-7-icon.png Use Reset
 
Fc9-type-5-icon.png Reset
Reset Pin 
Fc9-type-7-icon.png Use Backlight
 
Fc9-type-5-icon.png Backlight
Backlight Pin 
Fc9-type-7-icon.png Use DC Pin
Selects if the DC pins is available, Yes we use the DC pin to control if a data or commnd is being sent. No we add an extra bit to the data to do the job of the DC pin. 
Fc9-type-5-icon.png DC
Data/Command Pin 
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_GLCD_(ST7789V)_(Graphical_Color)&oldid=25799"