Difference between revisions of "Component: GLCD (4D Picaso v1) (EB076) (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: gra...")
 
 
(19 intermediate revisions by 2 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)
+
| 2.0
|-
 
| width="20%" style="color: gray;" | Category
 
| Displays: Graphical
 
 
|-
 
|-
| colspan="2" | This inherits from [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]
+
| width="20%" style="color:gray;" | Category
 +
| Graphical Color
 
|}
 
|}
  
  
 +
==GLCD (4D Picaso v1) component==
 +
Graphical display component designed to work with the Picaso range of displays from 4D Systems. Component based around the uLCD-32PT display.
  
==[[File:Component Icon c6586b24_9a1c_4e19_8051_8ae5923c418a.png|Image]] GLCD (EB076, 4D_Picaso) component==
+
==Detailed description==
Graphical display component designed to work with the Picaso range of displays from 4D Systems.
 
Also available in the form of the EB076 GLCD Touchscreen E-block.
 
Component based around the uLCD-32PT display.
 
  
==Examples==
 
EB076 gLCD Example File with touch draw support.
 
{{Fcfile|EB076_Test.fcfx|EB076 Example}}
 
Example should show the following on the display on the panel and on the hardware. Note that the "TOUCH" was draw by hand by clicking and dragging the mouse around over the LCD while simulation is running.
 
  
[[File:EB076.jpg]]
 
  
==Downloadable macro reference==
 
  
''This component inherits downloadable macros from ''[[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]
 
  
===<span style="font-weight: normal;"><u><tt>ReadASCIILUT</tt></u></span>===
 
Gets a byte of the embedded ASCII font data.
 
  
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
  
'''Parameters'''
 
  
:[[Variable Types|BYTE]] ''pos_str''
 
::ASCII position -32 so A = 'A' - 32 = 33
 
  
:[[Variable Types|BYTE]] ''count''
 
::Font column Ranging 0-4
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
  
===<span style="font-weight: normal;"><u><tt>G4D_ReadTouchCoordinatesPicaso</tt></u></span>===
 
Returns the coordinates of the last touch event.
 
  
Axis = 0 or 'x' or 'X' - Returns the X coordinate.
 
  
Axis = 1 or 'y' or 'Y' - Returns the Y coordinate.
 
  
'''Parameters'''
 
  
:[[Variable Types|BYTE]] ''Axis''
 
  
  
'''Return value'''
 
  
:[[Variable Types|UINT]]
 
  
  
===<span style="font-weight: normal;"><u><tt>G4D_InitialiseCard</tt></u></span>===
 
Initialises the micro SD card inserted into the module is available.
 
  
Returns 0 for succesful initialisation or 255 for a detected failure.
 
  
'''Parameters'''
+
''No detailed description exists yet for this component''
  
:''This macro has no parameters''
+
==Examples==
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
  
===<span style="font-weight: normal;"><u><tt>G4D_DumpScreenToFilePicaso</tt></u></span>===
 
Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height.
 
  
'''Parameters'''
 
  
:[[Variable Types|UINT]] ''X''
 
  
:[[Variable Types|UINT]] ''Y''
 
  
:[[Variable Types|UINT]] ''Width''
 
  
:[[Variable Types|UINT]] ''Height''
 
  
:[[Variable Types|<- STRING]] ''Filename''
 
::Assigns the name of the file on the card to store the data.
 
::''This parameter may be returned back to the caller''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
  
===<span style="font-weight: normal;"><u><tt>G4D_GetTouchCoordinatesPicaso</tt></u></span>===
 
Reads the value of the last touchscreen input from the display.
 
  
Returns a 0 if no new touch is detected.
 
  
Returns a 1 if a press is detected.
 
  
Returns a 2 if a release is detected.
 
  
Returns a 3 if a moving drag is detected.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
  
===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>===
+
EB076 gLCD Example File with touch draw support.
This macro prints a decimal number to the Graphical LCD.
 
  
'''Parameters'''
+
{{Fcfile|EB076_Test.fcfx|EB076 Example}}
  
:[[Variable Types|INT]] ''Number''
 
::Byte or Integer number to send to the display.
 
  
:[[Variable Types|UINT]] ''X''
+
Example should show the following on the display on the panel and on the hardware. Note that the "TOUCH" was draw by hand by clicking and dragging the mouse around over the LCD while simulation is running.
::X pixel coordinate to set the output string position.
 
  
:[[Variable Types|UINT]] ''Y''
+
[[File:EB076.jpg]]
::Y pixel coordinate to set the output string position.
 
  
:[[Variable Types|BYTE]] ''Font''
 
::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
 
  
:[[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''
 
  
:[[Variable Types|UINT]] ''Y1''
 
  
:[[Variable Types|UINT]] ''X2''
 
  
:[[Variable Types|UINT]] ''Y2''
 
  
  
'''Return value'''
 
  
:''This call does not return a value''
+
==Macro reference==
  
 +
===BPlot===
 +
{| 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>G4D_DisplayImageFromFilePicaso</tt></u></span>===
 
Attempts to print an image from the micro SD card using the specified filename on the card.
 
  
The image is printed at location starting from X, Y.
+
===ClearDisplay===
 +
{| 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''
 +
|}
  
PosH and PosL specify the sector address of the previously stored image icon.
 
  
'''Parameters'''
+
===DisplayControl===
 +
{| 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;" | '''DisplayControl'''
 +
|-
 +
| colspan="2" | Controls the operation, contrast and backlight on the display&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Backlight
 +
|-
 +
| colspan="2" | 0=Backlight Off, 1=Backlight On (default)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Display
 +
|-
 +
| colspan="2" | 0=Display off, 1=Display on (default)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Contrast
 +
|-
 +
| colspan="2" | Contrast Range 0 - 15&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''
 
  
:[[Variable Types|UINT]] ''Y''
+
===DrawCircle===
 +
{| 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;" | '''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''
 +
|}
  
:[[Variable Types|STRING]] ''Filename''
 
  
:[[Variable Types|UINT]] ''PosH''
+
===DrawEllipse===
 +
{| 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|UINT]] ''PosL''
 
  
 +
===DrawLine===
 +
{| 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''
 +
|}
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
+
===DrawRectangle===
 +
{| 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''
 +
|}
  
  
===<span style="font-weight: normal;"><u><tt>G4D_DisableTouchscreenPicaso</tt></u></span>===
+
===FastPlot===
Disables the touchscreen interface if available.
+
{| 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;" | '''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''
 +
|}
  
'''Parameters'''
 
  
:''This macro has no parameters''
+
===G4D_DisableTouchscreenPicaso===
 +
{| 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;" | '''G4D_DisableTouchscreenPicaso'''
 +
|-
 +
| colspan="2" | Disables the touchscreen interface if available.&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'''
+
===G4D_DisplayImageFromCard===
 +
{| 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;" | '''G4D_DisplayImageFromCard'''
 +
|-
 +
| colspan="2" | Attempts to print an image from the micro SD card at the specified address location on the card. The image is printed at location starting from X, Y and ranging to Width, Height. &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Height
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ColourMode
 +
|-
 +
| colspan="2" | Specifies the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddH
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddM
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddL
 +
|-
 +
| colspan="2" | &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]]
 
  
 +
===G4D_DisplayImageFromFilePicaso===
 +
{| 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;" | '''G4D_DisplayImageFromFilePicaso'''
 +
|-
 +
| colspan="2" | Attempts to print an image from the micro SD card using the specified filename on the card. The image is printed at location starting from X, Y. PosH and PosL specify the sector address of the previously stored image icon. &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Filename
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | PosH
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | PosL
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
===<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'''
+
===G4D_DisplayVideoFromCard===
 +
{| 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;" | '''G4D_DisplayVideoFromCard'''
 +
|-
 +
| colspan="2" | Attempts to display a sequence of images from the micro SD card at the specified address location on the card. The images are printed at location starting from X, Y and ranging to Width, Height. &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Height
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ColourMode
 +
|-
 +
| colspan="2" | Specifes the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | Specifies the number of milliseconds to wait in between displaying each image.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Frames
 +
|-
 +
| colspan="2" | Specifies the number of frames to display.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddH
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddM
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddL
 +
|-
 +
| colspan="2" | &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]] ''X1''
 
  
:[[Variable Types|UINT]] ''Y1''
+
===G4D_DumpScreenToCard===
 +
{| 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;" | '''G4D_DumpScreenToCard'''
 +
|-
 +
| colspan="2" | Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height. The address parameters assign where on the card to store the data.  &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Height
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddH
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddM
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddL
 +
|-
 +
| colspan="2" | &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'''
+
===G4D_DumpScreenToFilePicaso===
 +
{| 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;" | '''G4D_DumpScreenToFilePicaso'''
 +
|-
 +
| colspan="2" | Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height. &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Height
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Filename
 +
|-
 +
| colspan="2" | Assigns the name of the file on the card to store the data.&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''
 +
|}
  
:''This call does not return a value''
 
  
 +
===G4D_EnableTouchscreenPicaso===
 +
{| 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;" | '''G4D_EnableTouchscreenPicaso'''
 +
|-
 +
| colspan="2" | Enables the touchscreen interface if available.&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''
 +
|}
  
===<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'''
+
===G4D_GetTouchCoordinatesPicaso===
 +
{| 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;" | '''G4D_GetTouchCoordinatesPicaso'''
 +
|-
 +
| colspan="2" | Reads the value of the last touchscreen input from the display. Returns a 0 if no new touch is detected. Returns a 1 if a press is detected. Returns a 2 if a release is detected. Returns a 3 if a moving drag is detected.&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]] ''X''
 
::X Coordinate for the center of the circle
 
  
:[[Variable Types|UINT]] ''Y''
+
===G4D_InitialiseCard===
::Y coordinate for the center of the circle
+
{| 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;" | '''G4D_InitialiseCard'''
 +
|-
 +
| colspan="2" | Initialises the micro SD card inserted into the module is available. Returns 0 for succesful initialisation or 255 for a detected failure.&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]] ''XRadius''
 
::Radius of the circle on the X axis specified in pixels
 
  
:[[Variable Types|UINT]] ''YRadius''
+
===G4D_PlayAudioFromFilePicaso===
::Radius of the circle on the Y axis specified in pixels
+
{| 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;" | '''G4D_PlayAudioFromFilePicaso'''
 +
|-
 +
| colspan="2" | Attempts to stream an audio wav file from the micro SD card using the specified filename. &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Play_Option
 +
|-
 +
| colspan="2" | Play_Option = 0 - Return when playing complete / 1 - Return immediatley / 2 - Stop Playback / 3 - Pause Playback / 4 - Resume Playback / 5 - Loop Playing until stopped&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Filename
 +
|-
 +
| colspan="2" | &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]] ''Transparent''
 
::0=Fill inside circle using background colour / 1=Draw outer circle only
 
  
:[[Variable Types|BYTE]] ''Solid''
+
===G4D_ReadTouchCoordinatesPicaso===
::0=Use Transparent Setting / 1=Fill with foreground colour
+
{| 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;" | '''G4D_ReadTouchCoordinatesPicaso'''
 +
|-
 +
| colspan="2" | Returns the coordinates of the last touch event. Axis = 0 or 'x' or 'X' - Returns the X coordinate. Axis = 1 or 'y' or 'Y' - Returns the Y coordinate.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
'''Return value'''
+
===G4D_SetTouchRegionPicaso===
 +
{| 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;" | '''G4D_SetTouchRegionPicaso'''
 +
|-
 +
| colspan="2" | Specifies the area of the screen which will respond to touchscreen inputs.&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-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
:''This call does not return a value''
 
  
 +
===G4D_SetVGADisplaySizePicaso===
 +
{| 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;" | '''G4D_SetVGADisplaySizePicaso'''
 +
|-
 +
| colspan="2" | Specifies the VGA display size in pixels. Size = 0 - 320 x 240 Resolution. Size = 1 - 640 x 480 Resolution. Size = 2 - 800 x 480 Resolution. Size = 3 - Custom Resolution&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Size
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
===<span style="font-weight: normal;"><u><tt>DisplayControl</tt></u></span>===
 
Controls the operation, contrast and backlight on the display
 
  
'''Parameters'''
+
===G4D_SetVolumePicaso===
 +
{| 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;" | '''G4D_SetVolumePicaso'''
 +
|-
 +
| colspan="2" | Sets the playback volume.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Volume
 +
|-
 +
| colspan="2" | Volume = 0 - Mute Enabled / 1 - Volume Down 8 / 3 - Volume Down 1 / 253 - Volume Up 1 / 254 - Volume Up 8 / 255 - Mute Disabled / 8 - Minimum Volume Level / 127 - Maximum Volume Level&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]] ''Backlight''
 
::0=Backlight Off, 1=Backlight On (default)
 
  
:[[Variable Types|BYTE]] ''Display''
+
===Initialise===
::0=Display off, 1=Display on (default)
+
{| 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;" | '''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''
 +
|}
  
:[[Variable Types|BYTE]] ''Contrast''
 
::Contrast Range 0 - 15
 
  
 +
===Plot===
 +
{| 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''
 +
|}
  
'''Return value'''
 
  
:''This call does not return a value''
+
===Print===
 +
{| 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" | Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height&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''
 +
|}
  
  
===<span style="font-weight: normal;"><u><tt>G4D_EnableTouchscreenPicaso</tt></u></span>===
+
===PrintNumber===
Enables the touchscreen interface if available.
+
{| 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: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" | Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height&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''
 +
|}
  
'''Parameters'''
 
  
:''This macro has no parameters''
+
===SetBackgroundColour===
 +
{| 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''
 +
|}
  
  
'''Return value'''
+
===SetDisplayOrientation===
 +
{| 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;" | '''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]]
 
  
 
+
===SetForegroundColour===
===<span style="font-weight: normal;"><u><tt>G4D_SetVolumePicaso</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets the playback volume.
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
'''Parameters'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetForegroundColour'''
 
+
|-
:[[Variable Types|BYTE]] ''Volume''
+
| colspan="2" | Specifies the colour of the foreground by creating a mixture of red, green and blue.&nbsp;
::Volume = 0 - Mute Enabled / 1 - Volume Down 8 / 3 - Volume Down 1 / 253 - Volume Up 1 / 254 - Volume Up 8 / 255 - Mute Disabled / 8 - Minimum Volume Level / 127 - Maximum Volume Level
+
|-
 
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
'''Return value'''
+
| width="90%" | Red
 
+
|-
:[[Variable Types|BYTE]]
+
| colspan="2" | 0 - 255 where 0 = no red and 255 = maximum red&nbsp;
 
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
===<span style="font-weight: normal;"><u><tt>G4D_DisplayVideoFromCard</tt></u></span>===
+
| width="90%" | Green
Attempts to display a sequence of images from the micro SD card at the specified address location on the card.
+
|-
 
+
| colspan="2" | 0 - 255 where 0 = no green and 255 = maximum green&nbsp;
The images are printed at location starting from X, Y and ranging to Width, Height.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
'''Parameters'''
+
| width="90%" | Blue
 
+
|-
:[[Variable Types|UINT]] ''X''
+
| colspan="2" | 0 - 255 where 0 = no blue and 255 = maximum blue&nbsp;
 
+
|-
:[[Variable Types|UINT]] ''Y''
+
| 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]] ''Width''
+
|}
 
 
:[[Variable Types|UINT]] ''Height''
 
 
 
:[[Variable Types|BYTE]] ''ColourMode''
 
::Specifes the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour.
 
 
 
:[[Variable Types|BYTE]] ''Delay''
 
::Specifies the number of milliseconds to wait in between displaying each image.
 
 
 
:[[Variable Types|UINT]] ''Frames''
 
::Specifies the number of frames to display.
 
 
 
:[[Variable Types|BYTE]] ''AddH''
 
 
 
:[[Variable Types|BYTE]] ''AddM''
 
 
 
:[[Variable Types|BYTE]] ''AddL''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<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>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>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''
 
::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
 
 
 
:[[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>G4D_SetVGADisplaySizePicaso</tt></u></span>===
 
Specifies the VGA display size in pixels.
 
 
 
Size = 0 - 320 x 240 Resolution.
 
 
 
Size = 1 - 640 x 480 Resolution.
 
 
 
Size = 2 - 800 x 480 Resolution.
 
 
 
Size = 3 - Custom Resolution
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|BYTE]] ''Size''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>G4D_DumpScreenToCard</tt></u></span>===
 
Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height.
 
 
 
The address parameters assign where on the card to store the data.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''X''
 
 
 
:[[Variable Types|UINT]] ''Y''
 
 
 
:[[Variable Types|UINT]] ''Width''
 
 
 
:[[Variable Types|UINT]] ''Height''
 
 
 
:[[Variable Types|BYTE]] ''AddH''
 
 
 
:[[Variable Types|BYTE]] ''AddM''
 
 
 
:[[Variable Types|BYTE]] ''AddL''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<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>G4D_DisplayImageFromCard</tt></u></span>===
 
Attempts to print an image from the micro SD card at the specified address location on the card.
 
 
 
The image is printed at location starting from X, Y and ranging to Width, Height.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''X''
 
 
 
:[[Variable Types|UINT]] ''Y''
 
 
 
:[[Variable Types|UINT]] ''Width''
 
 
 
:[[Variable Types|UINT]] ''Height''
 
 
 
:[[Variable Types|BYTE]] ''ColourMode''
 
::Specifies the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour.
 
 
 
:[[Variable Types|BYTE]] ''AddH''
 
 
 
:[[Variable Types|BYTE]] ''AddM''
 
 
 
:[[Variable Types|BYTE]] ''AddL''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<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>G4D_SetTouchRegionPicaso</tt></u></span>===
 
Specifies the area of the screen which will respond to touchscreen inputs.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''X1''
 
 
 
:[[Variable Types|UINT]] ''Y1''
 
 
 
:[[Variable Types|UINT]] ''X2''
 
 
 
:[[Variable Types|UINT]] ''Y2''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>G4D_PlayAudioFromFilePicaso</tt></u></span>===
 
Attempts to stream an audio wav file from the micro SD card using the specified filename.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|BYTE]] ''Play_Option''
 
::Play_Option = 0 - Return when playing complete / 1 - Return immediatley / 2 - Stop Playback / 3 - Pause Playback / 4 - Resume Playback / 5 - Loop Playing until stopped
 
 
 
:[[Variable Types|STRING]] ''Filename''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<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 inherits simulation macros from ''[[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]
 
 
 
===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>===
 
This macro prints a decimal number to the Graphical LCD.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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''
 
::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
 
 
 
:[[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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''X1''
 
 
 
:[[Variable Types|UINT]] ''Y1''
 
 
 
:[[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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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'''
 
 
 
:''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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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>BPlot</tt></u></span>===
 
Sets a pixel with the current background colour at pixel location X, Y.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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>Print</tt></u></span>===
 
This macro prints a string of characters to the Graphical LCD.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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''
 
::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
 
 
 
:[[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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''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.
 
 
 
''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]''
 
 
 
'''Parameters'''
 
 
 
:''This macro has no parameters''
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
  
  
 +
===Window===
 +
{| 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;" | '''Window'''
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
  
 
==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="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
Heigt 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 Width</u></span>
+
|-
 
+
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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 Height
This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.
+
|-
 
+
| colspan="2" | Heigt 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 Width
 
+
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.
+
| colspan="2" | Width of gLCD canvas measured in pixels. &nbsp;
 
+
|-
Specifies the initial foreground color.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colour
<span style="font-weight: normal;"><u>Background Colour</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 Colour
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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>Green Bit Depth</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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>UART Channel</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''channel''.
+
| width="90%" | Green Bit Depth
 
+
|-
UART Peripheral to use for communications with the display.
+
| colspan="2" | Specifies the green bit depth for the display. &nbsp;
 
+
|-
<span style="font-weight: normal;"><u>Reset Pin</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 ''reset_pin''.
+
|-
 
+
| colspan="2" | Specifies the blue bit depth for the display. &nbsp;
I/O pin connected to the reset signal on the gLCD
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>TX Pin</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 
+
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''tx_pin''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
UART transmit pin - connected to the RX pin on the 4D display
+
| width="90%" | Channel
 
+
|-
<span style="font-weight: normal;"><u>RX Pin</u></span>
+
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.&nbsp;
 
+
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''rx_pin''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
+
| width="90%" | TX
UART transmit pin - connected to the RX pin on the 4D display
+
|-
 
+
| colspan="2" | Pin to be used for Transmit data&nbsp;
<span style="font-weight: normal;"><u>High Speed</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''HighSpeed''.
+
| width="90%" | RX
 
+
|-
Determines if the baud rate is automaticaly switched from 9600 baud on initialise to 57600 baud.
+
| colspan="2" | Pin to be used for Receive data&nbsp;
 
+
|-
Only available in hardware mode.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
+
| width="90%" | Reset Pin
<span style="font-weight: normal;"><u>Display Method</u></span>
+
|-
 
+
| colspan="2" | I/O pin connected to the reset signal on the gLCD&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.
+
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Baud Options
 +
|-
 +
| colspan="2" | Baud rate option selector&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Baud Rate
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | High Speed
 +
|-
 +
| colspan="2" | Determines if the baud rate is automaticaly switched from 9600 baud on initialise to 57600 baud. Only available in hardware mode.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Scope Traces
 +
|-
 +
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not.    Simulation - draws an approximation of the UART data onto the scope trace.    ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Console Data
 +
|-
 +
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Console Columns
 +
|-
 +
| colspan="2" | Number of characters that can be displayed on a single line of the console.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Data Source
 +
|-
 +
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices    Nothing - Simulation data is ignored    COM port - Routes the communication data to and from a physical or virtual COM port      Injector - Routes the communication data via a data injector component on the Panel.&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_API_Display_4D_Picaso1.fcfx FC_Comp_Source_API_Display_4D_Picaso1.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_API_Display_4D_Picaso1.fcfx FC_Comp_Source_API_Display_4D_Picaso1.fcfx]

Latest revision as of 14:28, 1 March 2024

Author Matrix Ltd
Version 2.0
Category Graphical Color


GLCD (4D Picaso v1) component

Graphical display component designed to work with the Picaso range of displays from 4D Systems. Component based around the uLCD-32PT display.

Detailed description

No detailed description exists yet for this component

Examples

EB076 gLCD Example File with touch draw support.

FC6 Icon.png EB076 Example


Example should show the following on the display on the panel and on the hardware. Note that the "TOUCH" was draw by hand by clicking and dragging the mouse around over the LCD while simulation is running.

EB076.jpg








Macro reference

BPlot

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


ClearDisplay

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


DisplayControl

Fc9-comp-macro.png DisplayControl
Controls the operation, contrast and backlight on the display 
Fc9-u8-icon.png - BYTE Backlight
0=Backlight Off, 1=Backlight On (default) 
Fc9-u8-icon.png - BYTE Display
0=Display off, 1=Display on (default) 
Fc9-u8-icon.png - BYTE Contrast
Contrast Range 0 - 15 
Fc9-void-icon.png - VOID Return


DrawCircle

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


DrawEllipse

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


DrawLine

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


DrawRectangle

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


FastPlot

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


G4D_DisableTouchscreenPicaso

Fc9-comp-macro.png G4D_DisableTouchscreenPicaso
Disables the touchscreen interface if available. 
Fc9-u8-icon.png - BYTE Return


G4D_DisplayImageFromCard

Fc9-comp-macro.png G4D_DisplayImageFromCard
Attempts to print an image from the micro SD card at the specified address location on the card. The image is printed at location starting from X, Y and ranging to Width, Height.  
Fc9-u16-icon.png - UINT X
 
Fc9-u16-icon.png - UINT Y
 
Fc9-u16-icon.png - UINT Width
 
Fc9-u16-icon.png - UINT Height
 
Fc9-u8-icon.png - BYTE ColourMode
Specifies the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour. 
Fc9-u8-icon.png - BYTE AddH
 
Fc9-u8-icon.png - BYTE AddM
 
Fc9-u8-icon.png - BYTE AddL
 
Fc9-u8-icon.png - BYTE Return


G4D_DisplayImageFromFilePicaso

Fc9-comp-macro.png G4D_DisplayImageFromFilePicaso
Attempts to print an image from the micro SD card using the specified filename on the card. The image is printed at location starting from X, Y. PosH and PosL specify the sector address of the previously stored image icon.  
Fc9-u16-icon.png - UINT X
 
Fc9-u16-icon.png - UINT Y
 
Fc9-string-icon.png - STRING Filename
 
Fc9-u16-icon.png - UINT PosH
 
Fc9-u16-icon.png - UINT PosL
 
Fc9-u8-icon.png - BYTE Return


G4D_DisplayVideoFromCard

Fc9-comp-macro.png G4D_DisplayVideoFromCard
Attempts to display a sequence of images from the micro SD card at the specified address location on the card. The images are printed at location starting from X, Y and ranging to Width, Height.  
Fc9-u16-icon.png - UINT X
 
Fc9-u16-icon.png - UINT Y
 
Fc9-u16-icon.png - UINT Width
 
Fc9-u16-icon.png - UINT Height
 
Fc9-u8-icon.png - BYTE ColourMode
Specifes the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour. 
Fc9-u8-icon.png - BYTE Delay
Specifies the number of milliseconds to wait in between displaying each image. 
Fc9-u16-icon.png - UINT Frames
Specifies the number of frames to display. 
Fc9-u8-icon.png - BYTE AddH
 
Fc9-u8-icon.png - BYTE AddM
 
Fc9-u8-icon.png - BYTE AddL
 
Fc9-u8-icon.png - BYTE Return


G4D_DumpScreenToCard

Fc9-comp-macro.png G4D_DumpScreenToCard
Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height. The address parameters assign where on the card to store the data.  
Fc9-u16-icon.png - UINT X
 
Fc9-u16-icon.png - UINT Y
 
Fc9-u16-icon.png - UINT Width
 
Fc9-u16-icon.png - UINT Height
 
Fc9-u8-icon.png - BYTE AddH
 
Fc9-u8-icon.png - BYTE AddM
 
Fc9-u8-icon.png - BYTE AddL
 
Fc9-u8-icon.png - BYTE Return


G4D_DumpScreenToFilePicaso

Fc9-comp-macro.png G4D_DumpScreenToFilePicaso
Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height.  
Fc9-u16-icon.png - UINT X
 
Fc9-u16-icon.png - UINT Y
 
Fc9-u16-icon.png - UINT Width
 
Fc9-u16-icon.png - UINT Height
 
Fc9-string-icon.png - STRING Filename
Assigns the name of the file on the card to store the data. 
Fc9-u8-icon.png - BYTE Return


G4D_EnableTouchscreenPicaso

Fc9-comp-macro.png G4D_EnableTouchscreenPicaso
Enables the touchscreen interface if available. 
Fc9-u8-icon.png - BYTE Return


G4D_GetTouchCoordinatesPicaso

Fc9-comp-macro.png G4D_GetTouchCoordinatesPicaso
Reads the value of the last touchscreen input from the display. Returns a 0 if no new touch is detected. Returns a 1 if a press is detected. Returns a 2 if a release is detected. Returns a 3 if a moving drag is detected. 
Fc9-u8-icon.png - BYTE Return


G4D_InitialiseCard

Fc9-comp-macro.png G4D_InitialiseCard
Initialises the micro SD card inserted into the module is available. Returns 0 for succesful initialisation or 255 for a detected failure. 
Fc9-u8-icon.png - BYTE Return


G4D_PlayAudioFromFilePicaso

Fc9-comp-macro.png G4D_PlayAudioFromFilePicaso
Attempts to stream an audio wav file from the micro SD card using the specified filename.  
Fc9-u8-icon.png - BYTE Play_Option
Play_Option = 0 - Return when playing complete / 1 - Return immediatley / 2 - Stop Playback / 3 - Pause Playback / 4 - Resume Playback / 5 - Loop Playing until stopped 
Fc9-string-icon.png - STRING Filename
 
Fc9-u8-icon.png - BYTE Return


G4D_ReadTouchCoordinatesPicaso

Fc9-comp-macro.png G4D_ReadTouchCoordinatesPicaso
Returns the coordinates of the last touch event. Axis = 0 or 'x' or 'X' - Returns the X coordinate. Axis = 1 or 'y' or 'Y' - Returns the Y coordinate. 
Fc9-u8-icon.png - BYTE Axis
 
Fc9-u16-icon.png - UINT Return


G4D_SetTouchRegionPicaso

Fc9-comp-macro.png G4D_SetTouchRegionPicaso
Specifies the area of the screen which will respond to touchscreen inputs. 
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 Return


G4D_SetVGADisplaySizePicaso

Fc9-comp-macro.png G4D_SetVGADisplaySizePicaso
Specifies the VGA display size in pixels. Size = 0 - 320 x 240 Resolution. Size = 1 - 640 x 480 Resolution. Size = 2 - 800 x 480 Resolution. Size = 3 - Custom Resolution 
Fc9-u8-icon.png - BYTE Size
 
Fc9-u8-icon.png - BYTE Return


G4D_SetVolumePicaso

Fc9-comp-macro.png G4D_SetVolumePicaso
Sets the playback volume. 
Fc9-u8-icon.png - BYTE Volume
Volume = 0 - Mute Enabled / 1 - Volume Down 8 / 3 - Volume Down 1 / 253 - Volume Up 1 / 254 - Volume Up 8 / 255 - Mute Disabled / 8 - Minimum Volume Level / 127 - Maximum Volume Level 
Fc9-u8-icon.png - BYTE Return


Initialise

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


Plot

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


Print

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
Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height 
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


PrintNumber

Fc9-comp-macro.png PrintNumber
This macro prints a decimal number to the Graphical LCD. 
Fc9-s16-icon.png - INT 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
Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height 
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


SetBackgroundColour

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


SetDisplayOrientation

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


SetForegroundColour

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


Window

Fc9-comp-macro.png Window
 
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


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Dimensions
Fc9-type-14-icon.png Pixel Height
Heigt of gLCD canvas measured in pixels.  
Fc9-type-14-icon.png Pixel Width
Width of gLCD canvas measured in pixels.  
Fc9-conn-icon.png Colour
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 Colour
Specifies the initial background color.  
Fc9-conn-icon.png Bit Depth
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-conn-icon.png Connections
Fc9-type-16-icon.png Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-type-5-icon.png Reset Pin
I/O pin connected to the reset signal on the gLCD 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-type-7-icon.png High Speed
Determines if the baud rate is automaticaly switched from 9600 baud on initialise to 57600 baud. Only available in hardware mode. 
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Component Label
 
Fc9-type-15-icon.png Component Label Scale
The label scale can be change if the amout of text is too wide for the display  
Fc9-type-16-icon.png Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware. 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. 

Component Source Code

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

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