Difference between revisions of "Component: GLCD (ILI9341) (Displays: Graphical)"
(XML import) |
(XML import) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 12: | Line 12: | ||
| Displays: Graphical | | Displays: Graphical | ||
|- | |- | ||
| − | | colspan="2" | This inherits from [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD | + | | colspan="2" | This inherits from [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]] |
|} | |} | ||
| Line 27: | Line 27: | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
| − | ''This component inherits downloadable macros from ''[[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD | + | ''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>=== | ===<span style="font-weight: normal;"><u><tt>ReadASCIILUT</tt></u></span>=== | ||
Gets a byte of the embedded ASCII font data. | Gets a byte of the embedded ASCII font data. | ||
| − | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 78: | Line 78: | ||
:[[Variable Types|BYTE]] ''Font'' | :[[Variable Types|BYTE]] ''Font'' | ||
| − | :: | + | ::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes |
:[[Variable Types|BYTE]] ''Transparent'' | :[[Variable Types|BYTE]] ''Transparent'' | ||
| Line 116: | Line 116: | ||
:[[Variable Types|UINT]] ''Y1'' | :[[Variable Types|UINT]] ''Y1'' | ||
| + | |||
| + | |||
| + | '''Return value''' | ||
| + | |||
| + | :''This call does not return a value'' | ||
| + | |||
| + | |||
| + | ===<span style="font-weight: normal;"><u><tt>DrawEllipse</tt></u></span>=== | ||
| + | Draws an ellipse object on the display with the center of the ellipse at the location X,Y | ||
| + | |||
| + | '''Parameters''' | ||
| + | |||
| + | :[[Variable Types|UINT]] ''X'' | ||
| + | ::X Coordinate for the center of the circle | ||
| + | |||
| + | :[[Variable Types|UINT]] ''Y'' | ||
| + | ::Y coordinate for the center of the circle | ||
| + | |||
| + | :[[Variable Types|UINT]] ''XRadius'' | ||
| + | ::Radius of the circle on the X axis specified in pixels | ||
| + | |||
| + | :[[Variable Types|UINT]] ''YRadius'' | ||
| + | ::Radius of the circle on the Y axis specified in pixels | ||
| + | |||
| + | :[[Variable Types|BYTE]] ''Transparent'' | ||
| + | ::0=Fill inside circle using background colour / 1=Draw outer circle only | ||
| + | |||
| + | :[[Variable Types|BYTE]] ''Solid'' | ||
| + | ::0=Use Transparent Setting / 1=Fill with foreground colour | ||
| Line 183: | Line 212: | ||
:[[Variable Types|BYTE]] ''Font'' | :[[Variable Types|BYTE]] ''Font'' | ||
| − | :: | + | ::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes |
:[[Variable Types|BYTE]] ''Transparent'' | :[[Variable Types|BYTE]] ''Transparent'' | ||
| Line 220: | Line 249: | ||
:[[Variable Types|BYTE]] ''Blue'' | :[[Variable Types|BYTE]] ''Blue'' | ||
::0 - 255 where 0 = no blue and 255 = maximum 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 | ||
| Line 288: | Line 343: | ||
==Simulation macro reference== | ==Simulation macro reference== | ||
| − | ''This component inherits simulation macros from ''[[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD | + | ''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>=== | ===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>=== | ||
This macro prints a decimal number to the Graphical LCD. | This macro prints a decimal number to the Graphical LCD. | ||
| − | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 307: | Line 362: | ||
:[[Variable Types|BYTE]] ''Font'' | :[[Variable Types|BYTE]] ''Font'' | ||
| − | :: | + | ::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes |
:[[Variable Types|BYTE]] ''Transparent'' | :[[Variable Types|BYTE]] ''Transparent'' | ||
| Line 321: | Line 376: | ||
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 342: | Line 397: | ||
Sets a pixel with the current foreground colour at pixel location X, Y. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 349: | Line 404: | ||
:[[Variable Types|UINT]] ''Y1'' | :[[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 | ||
| Line 359: | Line 445: | ||
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 375: | Line 461: | ||
Sets a pixel with the current background colour at pixel location X, Y. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 392: | Line 478: | ||
This macro prints a string of characters to the Graphical LCD. | This macro prints a string of characters to the Graphical LCD. | ||
| − | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 407: | Line 493: | ||
:[[Variable Types|BYTE]] ''Font'' | :[[Variable Types|BYTE]] ''Font'' | ||
| − | :: | + | ::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes |
:[[Variable Types|BYTE]] ''Transparent'' | :[[Variable Types|BYTE]] ''Transparent'' | ||
| Line 421: | Line 507: | ||
This macro clears the display of any previous output by overwriting the entire display with the background colour. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 436: | Line 522: | ||
Specifies the colour of the background by creating a mixture of red, green and blue. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 448: | Line 534: | ||
:[[Variable Types|BYTE]] ''Blue'' | :[[Variable Types|BYTE]] ''Blue'' | ||
::0 - 255 where 0 = no blue and 255 = maximum 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 | ||
| Line 458: | Line 572: | ||
Specifies the colour of the foreground by creating a mixture of red, green and blue. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 480: | Line 594: | ||
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
| Line 507: | Line 621: | ||
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. | 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 | + | ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD Base]]'' |
'''Parameters''' | '''Parameters''' | ||
Latest revision as of 10:27, 9 May 2018
| Author | Matrix Ltd |
| Version | 1.8 (Release) |
| Category | Displays: Graphical |
| This inherits from GLCD Base | |
Contents
GLCD (ILI9341) component
Graphical display component designed to work with the ILI9341 controller IC Based on the ILI9341 16-bit colour graphical controller IC.
Examples
No additional examples
Downloadable macro reference
This component inherits downloadable macros from GLCD Base
ReadASCIILUT
Gets a byte of the embedded ASCII font data.
This call is provided by GLCD Base
Parameters
- BYTE pos_str
- ASCII position -32 so A = 'A' - 32 = 33
- BYTE count
- Font column Ranging 0-4
Return value
BacklightOn
Sets the backlight enable pin allowing the display backlight to switch on.
Switching the backlight on and off at high speed allow the light to be dimmed.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
PrintNumber
This macro prints a decimal number to the Graphical LCD.
Parameters
- INT Number
- Byte or Integer number to send to the display.
- UINT X
- X pixel coordinate to set the output string position.
- UINT Y
- Y pixel coordinate to set the output string position.
- BYTE Font
- Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
- BYTE Transparent
- Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
Return value
- This call does not return a value
DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.
Parameters
- UINT X1
- UINT Y1
- UINT X2
- UINT Y2
Return value
- This call does not return a value
Plot
Sets a pixel with the current foreground colour at pixel location X, Y.
Parameters
- UINT X1
- UINT Y1
Return value
- This call does not return a value
DrawEllipse
Draws an ellipse object on the display with the center of the ellipse at the location X,Y
Parameters
- UINT X
- X Coordinate for the center of the circle
- UINT Y
- Y coordinate for the center of the circle
- UINT XRadius
- Radius of the circle on the X axis specified in pixels
- UINT YRadius
- Radius of the circle on the Y axis specified in pixels
- BYTE Transparent
- 0=Fill inside circle using background colour / 1=Draw outer circle only
- BYTE Solid
- 0=Use Transparent Setting / 1=Fill with foreground colour
Return value
- This call does not return a value
SetDisplayOrientation
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.
Parameters
- BYTE Orientation
- 0=Default, 1=90°CW, 2=180°CW, 3=270°CW
Return value
- This call does not return a value
BacklightOff
Clears the backlight enable pin allowing the display backlight to switch off.
Switching the backlight on and off at high speed allow the light to be dimmed.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
BPlot
Sets a pixel with the current background colour at pixel location X, Y.
Parameters
- UINT X1
- UINT Y1
Return value
- This call does not return a value
This macro prints a string of characters to the Graphical LCD.
Parameters
- <- STRING Str
- String of characters to send to the display.
- This parameter may be returned back to the caller
- UINT X1
- X pixel coordinate to set the output string position.
- UINT Y1
- Y pixel coordinate to set the output string position.
- BYTE Font
- Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
- BYTE Transparent
- Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
Return value
- This call does not return a value
ClearDisplay
This macro clears the display of any previous output by overwriting the entire display with the background colour.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
SetBackgroundColour
Specifies the colour of the background by creating a mixture of red, green and blue.
Parameters
- BYTE Red
- 0 - 255 where 0 = no red and 255 = maximum red
- BYTE Green
- 0 - 255 where 0 = no green and 255 = maximum green
- BYTE Blue
- 0 - 255 where 0 = no blue and 255 = maximum blue
Return value
- This call does not return a value
DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y
Parameters
- UINT X
- X Coordinate for the center of the circle
- UINT Y
- Y coordinate for the center of the circle
- UINT Radius
- Radius of the circle specified in pixels
- BYTE Transparent
- 0=Fill inside circle using background colour / 1=Draw outer circle only
- BYTE Solid
- 0=Use Transparent Setting / 1=Fill with foreground colour
Return value
- This call does not return a value
SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.
Parameters
- BYTE Red
- 0 - 255 where 0 = no red and 255 = maximum red
- BYTE Green
- 0 - 255 where 0 = no green and 255 = maximum green
- BYTE Blue
- 0 - 255 where 0 = no blue and 255 = maximum blue
Return value
- This call does not return a value
DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
Parameters
- UINT X1
- UINT Y1
- UINT X2
- UINT Y2
- BYTE Transparent
- Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE Solid
- Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
Return value
- This call does not return a value
Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
This component inherits simulation macros from GLCD Base
PrintNumber
This macro prints a decimal number to the Graphical LCD.
This call is provided by GLCD Base
Parameters
- INT Number
- Byte or Integer number to send to the display.
- UINT X
- X pixel coordinate to set the output string position.
- UINT Y
- Y pixel coordinate to set the output string position.
- BYTE Font
- Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
- BYTE Transparent
- Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
Return value
- This call does not return a value
DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.
This call is provided by GLCD Base
Parameters
- UINT X1
- UINT Y1
- UINT X2
- UINT Y2
Return value
- This call does not return a value
Plot
Sets a pixel with the current foreground colour at pixel location X, Y.
This call is provided by GLCD Base
Parameters
- UINT X1
- UINT Y1
Return value
- This call does not return a value
DrawEllipse
Draws an ellipse object on the display with the center of the ellipse at the location X,Y
This call is provided by GLCD Base
Parameters
- UINT X
- X Coordinate for the center of the circle
- UINT Y
- Y coordinate for the center of the circle
- UINT XRadius
- Radius of the circle on the X axis specified in pixels
- UINT YRadius
- Radius of the circle on the Y axis specified in pixels
- BYTE Transparent
- 0=Fill inside circle using background colour / 1=Draw outer circle only
- BYTE Solid
- 0=Use Transparent Setting / 1=Fill with foreground colour
Return value
- This call does not return a value
SetDisplayOrientation
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.
This call is provided by GLCD Base
Parameters
- BYTE Orientation
- 0=Default, 1=90°CW, 2=180°CW, 3=270°CW
Return value
- This call does not return a value
BPlot
Sets a pixel with the current background colour at pixel location X, Y.
This call is provided by GLCD Base
Parameters
- UINT X1
- UINT Y1
Return value
- This call does not return a value
This macro prints a string of characters to the Graphical LCD.
This call is provided by GLCD Base
Parameters
- <- STRING Str
- String of characters to send to the display.
- This parameter may be returned back to the caller
- UINT X1
- X pixel coordinate to set the output string position.
- UINT Y1
- Y pixel coordinate to set the output string position.
- BYTE Font
- Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
- BYTE Transparent
- Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
Return value
- This call does not return a value
ClearDisplay
This macro clears the display of any previous output by overwriting the entire display with the background colour.
This call is provided by GLCD Base
Parameters
- This macro has no parameters
Return value
- This call does not return a value
SetBackgroundColour
Specifies the colour of the background by creating a mixture of red, green and blue.
This call is provided by GLCD Base
Parameters
- BYTE Red
- 0 - 255 where 0 = no red and 255 = maximum red
- BYTE Green
- 0 - 255 where 0 = no green and 255 = maximum green
- BYTE Blue
- 0 - 255 where 0 = no blue and 255 = maximum blue
Return value
- This call does not return a value
DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y
This call is provided by GLCD Base
Parameters
- UINT X
- X Coordinate for the center of the circle
- UINT Y
- Y coordinate for the center of the circle
- UINT Radius
- Radius of the circle specified in pixels
- BYTE Transparent
- 0=Fill inside circle using background colour / 1=Draw outer circle only
- BYTE Solid
- 0=Use Transparent Setting / 1=Fill with foreground colour
Return value
- This call does not return a value
SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.
This call is provided by GLCD Base
Parameters
- BYTE Red
- 0 - 255 where 0 = no red and 255 = maximum red
- BYTE Green
- 0 - 255 where 0 = no green and 255 = maximum green
- BYTE Blue
- 0 - 255 where 0 = no blue and 255 = maximum blue
Return value
- This call does not return a value
DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2.
This call is provided by GLCD Base
Parameters
- UINT X1
- UINT Y1
- UINT X2
- UINT Y2
- BYTE Transparent
- Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE Solid
- Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
Return value
- This call does not return a value
Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
This call is provided by GLCD Base
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Property reference
Pixel Height
This property is of type Signed integer and can be referenced with the variable name pixel_height.
Heigt of gLCD canvas measured in pixels.
Pixel Width
This property is of type Signed integer and can be referenced with the variable name pixel_width.
Width of gLCD canvas measured in pixels.
Monochrome
This property is of type True or false and can be referenced with the variable name monochrome.
Specifies if the display is capable of colour or monochrome only.
Foreground Color
This property is of type Color picker and can be referenced with the variable name foreground_colour.
Specifies the initial foreground color.
Background Color
This property is of type Color picker and can be referenced with the variable name background_colour.
Specifies the initial background color.
Colour Bit Depth
This property is of type Signed integer and can be referenced with the variable name colour_bit_depth.
Total color bit depth for the display.
Red Bit Depth
This property is of type Signed integer and can be referenced with the variable name red_bit_depth.
Specifies the red bit depth for the display.
Green Bit Depth
This property is of type Signed integer and can be referenced with the variable name green_bit_depth.
Specifies the green bit depth for the display.
Blue Bit Depth
This property is of type Signed integer and can be referenced with the variable name blue_bit_depth.
Specifies the blue bit depth for the display.
Data Out (MOSI)
This property is of type Single digital pin and can be referenced with the variable name dataout_pin.
Data pin connection
Clock
This property is of type Single digital pin and can be referenced with the variable name clock_pin.
Clock pin connection
Chip Select
This property is of type Single digital pin and can be referenced with the variable name chip_sel_pin.
Chip select pin connection
D/C
This property is of type Single digital pin and can be referenced with the variable name dc_pin.
Instruction / Command pin connection
Reset
This property is of type Single digital pin and can be referenced with the variable name reset_pin.
Reset pin connection
LED
This property is of type Single digital pin and can be referenced with the variable name led_pin.
LED backlight strobe pin connection
Use Backlight Pin
This property is of type True or false and can be referenced with the variable name UseBacklight.
No additional information
Display Method
This property is of type Fixed list of ints and can be referenced with the variable name DisplayMethod.
Chooses which method to use when drawing to the gLCD component
The bitmap is the more common mode but may run slowly on some machines.
The point cloud should run faster but may use more memory.
