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

Revision as of 09:56, 27 January 2023

Author	Matrix Ltd
Version	1.6
Category	EBM Modules

GLCD (EBM001) component

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

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

EBM001 Basic Example

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

EBM001 Maze Builder

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

EBM001 Drawing 3D Objects With Perspective

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

Macro reference

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

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

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

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

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

- UINT	Y1

- VOID	Return

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

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

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

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

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

- UINT	Y1

- VOID	Return

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

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

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

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

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

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

	DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
- UINT	X1

- UINT	Y1

- UINT	X2

- UINT	Y2

- BYTE	Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE	Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
- VOID	Return

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

Property reference

	Properties
	Dimensions
	Pixel Width
Width of gLCD canvas measured in pixels.
	Pixel Height
Heigt of gLCD canvas measured in pixels.
	Colour
	Monochrome
Specifies if the display is capable of colour or monochrome only.
	Foreground Color
Specifies the initial foreground color.
	Background Color
Specifies the initial background color.
	Bit Depth
	Colour Bit Depth
Total color bit depth for the display.
	Red Bit Depth
Specifies the red bit depth for the display.
	Green Bit Depth
Specifies the green bit depth for the display.
	Blue Bit Depth
Specifies the blue bit depth for the display.
	Connections
	Data
Data pin connection
	Clock
Clock pin connection
	Chip Select
Chip select pin connection
	A0
Instruction / Command pin connection
	Reset
Reset pin connection
	LED
LED backlight strobe pin connection
	Fonts
	Font Count
Specifies the number of fonts available to use on the display.
	Font 0
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Simulation
	Component Label

	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
	Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware.

==Macro reference==

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

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

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

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

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

- UINT	Y1

- VOID	Return

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

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

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

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

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

- UINT	Y1

- VOID	Return

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

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

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

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

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

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

	DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
- UINT	X1

- UINT	Y1

- UINT	X2

- UINT	Y2

- BYTE	Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE	Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
- VOID	Return

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

Property reference

	Properties
	Dimensions
	Pixel Width
Width of gLCD canvas measured in pixels.
	Pixel Height
Heigt of gLCD canvas measured in pixels.
	Colour
	Monochrome
Specifies if the display is capable of colour or monochrome only.
	Foreground Color
Specifies the initial foreground color.
	Background Color
Specifies the initial background color.
	Bit Depth
	Colour Bit Depth
Total color bit depth for the display.
	Red Bit Depth
Specifies the red bit depth for the display.
	Green Bit Depth
Specifies the green bit depth for the display.
	Blue Bit Depth
Specifies the blue bit depth for the display.
	Connections
	Data
Data pin connection
	Clock
Clock pin connection
	Chip Select
Chip select pin connection
	A0
Instruction / Command pin connection
	Reset
Reset pin connection
	LED
LED backlight strobe pin connection
	Fonts
	Font Count
Specifies the number of fonts available to use on the display.
	Font 0
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Simulation
	Component Label

	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
	Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware.

==Macro reference==

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

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

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

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

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

- UINT	Y1

- VOID	Return

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

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

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

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

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

- UINT	Y1

- VOID	Return

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

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

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

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

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

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

	DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
- UINT	X1

- UINT	Y1

- UINT	X2

- UINT	Y2

- BYTE	Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE	Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
- VOID	Return

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

Property reference

	Properties
	Dimensions
	Pixel Width
Width of gLCD canvas measured in pixels.
	Pixel Height
Heigt of gLCD canvas measured in pixels.
	Colour
	Monochrome
Specifies if the display is capable of colour or monochrome only.
	Foreground Color
Specifies the initial foreground color.
	Background Color
Specifies the initial background color.
	Bit Depth
	Colour Bit Depth
Total color bit depth for the display.
	Red Bit Depth
Specifies the red bit depth for the display.
	Green Bit Depth
Specifies the green bit depth for the display.
	Blue Bit Depth
Specifies the blue bit depth for the display.
	Connections
	Data
Data pin connection
	Clock
Clock pin connection
	Chip Select
Chip select pin connection
	A0
Instruction / Command pin connection
	Reset
Reset pin connection
	LED
LED backlight strobe pin connection
	Fonts
	Font Count
Specifies the number of fonts available to use on the display.
	Font 0
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Simulation
	Component Label

	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
	Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware.

==Macro reference==

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

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

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

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

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

- UINT	Y1

- VOID	Return

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

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

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

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

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

- UINT	Y1

- VOID	Return

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

- UINT	Y1

- UINT	X2

- UINT	Y2

- VOID	Return

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

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

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

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

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

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

	DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
- UINT	X1

- UINT	Y1

- UINT	X2

- UINT	Y2

- BYTE	Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE	Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
- VOID	Return

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

Property reference

	Properties
	Dimensions
	Pixel Width
Width of gLCD canvas measured in pixels.
	Pixel Height
Heigt of gLCD canvas measured in pixels.
	Colour
	Monochrome
Specifies if the display is capable of colour or monochrome only.
	Foreground Color
Specifies the initial foreground color.
	Background Color
Specifies the initial background color.
	Bit Depth
	Colour Bit Depth
Total color bit depth for the display.
	Red Bit Depth
Specifies the red bit depth for the display.
	Green Bit Depth
Specifies the green bit depth for the display.
	Blue Bit Depth
Specifies the blue bit depth for the display.
	Connections
	Data
Data pin connection
	Clock
Clock pin connection
	Chip Select
Chip select pin connection
	A0
Instruction / Command pin connection
	Reset
Reset pin connection
	LED
LED backlight strobe pin connection
	Fonts
	Font Count
Specifies the number of fonts available to use on the display.
	Font 0
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Simulation
	Component Label

	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
	Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware.

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

Revision as of 09:56, 27 January 2023

Contents

GLCD (EBM001) component

Component Source Code

Detailed description

Examples

EBM001 Basic Example

EBM001 Maze Builder

EBM001 Drawing 3D Objects With Perspective

Macro reference

Property reference

Property reference

Property reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_GLCD_EBM001.fcfx FC_Comp_Source_GLCD_EBM001.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_GLCD_EBM001.fcfx FC_Comp_Source_GLCD_EBM001.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_GLCD_EBM001.fcfx FC_Comp_Source_GLCD_EBM001.fcfx]
 ==Detailed description==
@@ Line 44: / Line 46: @@
 ==Examples==
@@ Line 90: / Line 94: @@
 ==Macro reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFontWidth'''
+|-
+| colspan="2" | Reads the number of pixel columns used in the selected font&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Font
+|-
+| colspan="2" | Font selection range: 0 to (NumFonts - 1)&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Character
+|-
+| colspan="2" | ASCII character to get the pixel width e.g. 'A' or 65&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BacklightOn'''
+|-
+| colspan="2" | Sets the backlight enable pin allowing the display backlight to switch on. Switching the backlight on and off at high speed allow the light to be dimmed.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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;" | '''SetFontScaler'''
+|-
+| colspan="2" | Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | ScaleX
+|-
+| colspan="2" | Sets the horizontal scale of the font, default 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | ScaleY
+|-
+| colspan="2" | Sets the vertical scale of the font, default 1&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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" | Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Transparent
+|-
+| colspan="2" | Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BacklightOff'''
+|-
+| colspan="2" | Clears the backlight enable pin allowing the display backlight to switch off. Switching the backlight on and off at high speed allow the light to be dimmed.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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''
+|}
+{| 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" | Specifies a full screen or sub window of pixels to draw. Useful when used with the FastPlot function to draw bitmaps at high speed.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | X1
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Y1
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | X2
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Y2
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFontStat'''
+|-
+| colspan="2" | Gets a stat from the selected embedded ASCII font data.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Font
+|-
+| colspan="2" | Font selection range: 0 to (NumFonts - 1)&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Index
+|-
+| colspan="2" | 0=SpaceWidth, 1=PixelHeight&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Print'''
+|-
+| colspan="2" | This macro prints a string of characters to the Graphical LCD.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Str
+|-
+| colspan="2" | String of characters to send to the display.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | X1
+|-
+| colspan="2" | X pixel coordinate to set the output string position.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Y1
+|-
+| colspan="2" | Y pixel coordinate to set the output string position.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Font
+|-
+| colspan="2" | Selects which Font to use Range: 0 to Font Count&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Transparent
+|-
+| colspan="2" | Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetForegroundColour'''
+|-
+| colspan="2" | Specifies the colour of the foreground by creating a mixture of red, green and blue. &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Red
+|-
+| colspan="2" | 0 - 255 where 0 = no red and 255 = maximum red&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Green
+|-
+| colspan="2" | 0 - 255 where 0 = no green and 255 = maximum green&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Blue
+|-
+| colspan="2" | 0 - 255 where 0 = no blue and 255 = maximum blue&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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''
+|}
+{| 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''
+|}
+==Property reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Dimensions
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Pixel Width
+|-
+| colspan="2" | Width of gLCD canvas measured in pixels.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Pixel Height
+|-
+| colspan="2" | Heigt of gLCD canvas measured in pixels.&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colour
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Monochrome
+|-
+| colspan="2" | Specifies if the display is capable of colour or monochrome only.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
+| width="90%" | Foreground Color
+|-
+| colspan="2" | Specifies the initial foreground color.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
+| width="90%" | Background Color
+|-
+| colspan="2" | Specifies the initial background color.&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Bit Depth
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Colour Bit Depth
+|-
+| colspan="2" | Total color bit depth for the display.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Red Bit Depth
+|-
+| colspan="2" | Specifies the red bit depth for the display.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Green Bit Depth
+|-
+| colspan="2" | Specifies the green bit depth for the display.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Blue Bit Depth
+|-
+| colspan="2" | Specifies the blue bit depth for the display.&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | Data
+|-
+| colspan="2" | Data pin connection&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | Clock
+|-
+| colspan="2" | Clock pin connection&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | Chip Select
+|-
+| colspan="2" | Chip select pin connection&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | A0
+|-
+| colspan="2" | Instruction / Command pin connection&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | Reset
+|-
+| colspan="2" | Reset pin connection&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | LED
+|-
+| colspan="2" | LED backlight strobe pin connection&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Fonts
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Font Count
+|-
+| colspan="2" | Specifies the number of fonts available to use on the display.&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Font 0
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Font
+|-
+| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Character Spacing
+|-
+| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Space Width
+|-
+| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
+|-
+| width="10%" align="center" 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;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"