Component: GLCD (SSD1331) (SSD1331) (Graphical Color)
| Author | Matrix Ltd |
| Version | 13.0 |
| Category | Graphical Color |
GLCD (SSD1331) component
Graphical display component based on the SSD1331 colour graphical controller IC.
Version information
Library Version, Component Version, Date, Author, Info 11, 1.0, 22-07-24, BR, Added DrawArc and DrawRoundedRectangle functions 13, 13.0, 02-08-24, MW, Added an aditional font count of 4, total font count of 8
Detailed description
Click here for an in depth guide to graphical LCDs using Flowcode.
Information on the Fonts available for this component are available here. GLCD Font Subcomponent
Examples
No additional examples
Macro reference
BPlot
|
BPlot |
| Sets a pixel with the current background colour at pixel location X, Y. | |
 - UINT
|
X1 |
| - UINT
|
Y1 |
 - VOID
|
Return |
ClearDisplay
|
|
ClearDisplay |
| This macro clears the display of any previous output by overwriting the entire display with the background colour. | |
| - VOID
|
Return |
ControlContrast
|
|
ControlContrast |
| Sets the display contrast from 0 to 255. | |
 - BYTE
|
Contrast |
| Range 0 - 255, Default 207 | |
| - VOID
|
Return |
ControlDisplay
|
|
ControlDisplay |
| Allows the display to be switched on and off | |
| - BYTE
|
Control |
| 0=Off, 1=On | |
| - VOID
|
Return |
DrawArc
|
|
DrawArc |
| Draws an arc either as an outline or as a filled object. | |
| - UINT
|
X |
| Center X coordinate | |
| - UINT
|
Y |
| Center Y coordinate | |
| - UINT
|
Radius |
| Radius, distance of edge from the centre coordinates | |
 - FLOAT
|
StartAngle |
| Angle to start drawing, in degrees | |
| - FLOAT
|
EndAngle |
| Angle to end drawing, in degrees | |
| - UINT
|
Resolution |
| Number of lines to draw from the center to the outer edge, 0=Fill | |
| - BYTE
|
Transparent |
| Chooses the transparency - 0 = Arc contains background colour, 1 = Arc contains previous pixel data. | |
| - BYTE
|
Solid |
| Chooses to fill with colour - 0 = Arc transparency data, 1 = Arc contains foreground colour. | |
| - VOID
|
Return |
DrawBezier
|
|
DrawBezier |
| Draws a quadratic Bezier curve with the current foreground colour from pixel location X0, Y0 to pixel location X2, Y2 using control point CX, CY. | |
| - UINT
|
X0 |
| Start X coordinate | |
| - UINT
|
Y0 |
| Start Y coordinate | |
| - UINT
|
CX |
| Control point X coordinate | |
| - UINT
|
CY |
| Control point Y coordinate | |
| - UINT
|
X2 |
| End X coordinate | |
| - UINT
|
Y2 |
| End Y coordinate | |
| - UINT
|
Resolution |
| Number of segments to approximate the curve, 0 chooses an automatic value based on curve size. | |
| - VOID
|
Return |
DrawCircle
|
|
DrawCircle |
| Draws a circle object on the display with the center of the circle at the location X,Y | |
| - UINT
|
X |
| X Coordinate for the center of the circle | |
| - UINT
|
Y |
| Y coordinate for the center of the circle | |
| - UINT
|
Radius |
| Radius of the circle specified in pixels | |
| - BYTE
|
Transparent |
| 0=Fill inside circle using background colour / 1=Draw outer circle only | |
| - BYTE
|
Solid |
| 0=Use Transparent Setting / 1=Fill with foreground colour | |
| - VOID
|
Return |
DrawEllipse
|
|
DrawEllipse |
| Draws an ellipse object on the display with the center of the ellipse at the location X,Y | |
| - UINT
|
X |
| X Coordinate for the center of the circle | |
| - UINT
|
Y |
| Y coordinate for the center of the circle | |
| - UINT
|
XRadius |
| Radius of the circle on the X axis specified in pixels | |
| - UINT
|
YRadius |
| Radius of the circle on the Y axis specified in pixels | |
| - BYTE
|
Transparent |
| 0=Fill inside circle using background colour / 1=Draw outer circle only | |
| - BYTE
|
Solid |
| 0=Use Transparent Setting / 1=Fill with foreground colour | |
| - VOID
|
Return |
DrawLine
|
|
DrawLine |
| Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. | |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - UINT
|
X2 |
| - UINT
|
Y2 |
| - VOID
|
Return |
DrawRectangle
|
|
DrawRectangle |
| Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 | |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - UINT
|
X2 |
| - UINT
|
Y2 |
| - BYTE
|
Transparent |
| Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. | |
| - BYTE
|
Solid |
| Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour. | |
| - VOID
|
Return |
DrawRoundedRectangle
|
|
DrawRoundedRectangle |
| Draws a rectangle with rounded corners | |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - UINT
|
X2 |
| - UINT
|
Y2 |
| - UINT
|
Radius |
| - BYTE
|
Transparent |
| Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. | |
| - BYTE
|
Solid |
| Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour. | |
| - VOID
|
Return |
FastPlot
|
|
FastPlot |
| Sets a pixel with the current foreground colour at current pixel location. Not compatible with orientations other than 0. | |
| - VOID
|
Return |
Initialise
|
|
Initialise |
| The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. | |
| - VOID
|
Return |
InvertDisplay
|
|
InvertDisplay |
| - VOID
|
Return |
Plot
|
|
Plot |
| Sets a pixel with the current foreground colour at pixel location X, Y. | |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - VOID
|
Return |
|
|
|
| This macro prints a string of characters to the Graphical LCD. | |
 - STRING
|
Str |
| String of characters to send to the display. | |
| - UINT
|
X1 |
| X pixel coordinate to set the output string position. | |
| - UINT
|
Y1 |
| Y pixel coordinate to set the output string position. | |
| - BYTE
|
Font |
| Selects which Font to use Range: 0 to Font Count | |
| - BYTE
|
Transparent |
| Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. | |
| - VOID
|
Return |
PrintNumber
|
|
PrintNumber |
| This macro prints a decimal number to the Graphical LCD. | |
 - INT
|
Number |
| Byte or Integer number to send to the display. | |
| - UINT
|
X |
| X pixel coordinate to set the output string position. | |
| - UINT
|
Y |
| Y pixel coordinate to set the output string position. | |
| - BYTE
|
Font |
| Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes | |
| - BYTE
|
Transparent |
| Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. | |
| - VOID
|
Return |
ReadFontStat
|
|
ReadFontStat |
| Gets a stat from the selected embedded ASCII font data. | |
| - BYTE
|
Font |
| Font selection range: 0 to (NumFonts - 1) | |
| - BYTE
|
Index |
| 0=SpaceWidth, 1=PixelHeight | |
| - BYTE
|
Return |
ReadFontWidth
|
|
ReadFontWidth |
| Reads the number of pixel columns used in the selected font | |
| - BYTE
|
Font |
| Font selection range: 0 to (NumFonts - 1) | |
| - BYTE
|
Character |
| ASCII character to get the pixel width e.g. 'A' or 65 | |
| - BYTE
|
Return |
SetBackgroundColour
|
|
SetBackgroundColour |
| Specifies the colour of the background by creating a mixture of red, green and blue. | |
| - BYTE
|
Red |
| Range: 0-255 | |
| - BYTE
|
Green |
| Range: 0-255 | |
| - BYTE
|
Blue |
| Range: 0-255 | |
| - VOID
|
Return |
SetDisplayOrientation
|
|
SetDisplayOrientation |
| Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. | |
| - BYTE
|
Orientation |
| 0=Default, 1=90°CW, 2=180°CW, 3=270°CW | |
| - VOID
|
Return |
SetFontScaler
|
|
SetFontScaler |
| Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y. | |
| - BYTE
|
ScaleX |
| Sets the horizontal scale of the font, default 1 | |
| - BYTE
|
ScaleY |
| Sets the vertical scale of the font, default 1 | |
| - VOID
|
Return |
SetForegroundColour
|
|
SetForegroundColour |
| Specifies the colour of the foreground by creating a mixture of red, green and blue. | |
| - BYTE
|
Red |
| Range: 0-255 | |
| - BYTE
|
Green |
| Range: 0-255 | |
| - BYTE
|
Blue |
| Range: 0-255 | |
| - VOID
|
Return |
Window
|
|
Window |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - UINT
|
X2 |
| - UINT
|
Y2 |
| - VOID
|
Return |
Property reference
|
Properties |
|
Dimensions |
|
Pixel Width |
| Width of gLCD canvas measured in pixels. | |
|
|
Pixel Height |
| Heigt of gLCD canvas measured in pixels. | |
|
|
Colour |
|
Monochrome |
| Specifies if the display is capable of colour or monochrome only. | |
|
Foreground Color |
| Specifies the initial foreground color. | |
|
|
Background Color |
| Specifies the initial background color. | |
|
|
Bit Depth |
|
|
Colour Bit Depth |
| Total color bit depth for the display. | |
|
|
Red Bit Depth |
| Specifies the red bit depth for the display. | |
|
|
Green Bit Depth |
| Specifies the green bit depth for the display. | |
|
|
Blue Bit Depth |
| Specifies the blue bit depth for the display. | |
|
|
Connections |
|
Channel |
| SPI Channel selector | |
|
|
Prescale |
| Prescale option selector | |
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
|
|
MOSI Remap Pin |
| Select which the target pin to assign the MOSI hardware pin functionality. | |
|
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
|
|
MISO Remap Pin |
| Select which the target pin to assign the MISO hardware pin functionality. | |
|
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
|
|
CLK Remap Pin |
| Select which the target pin to assign the CLK hardware pin functionality. | |
|
|
DC |
| Data/Command pin used to inform the display if data or commands are being sent. | |
|
|
Toggle CS Pin |
| Defines if the CS pin is left in the enabled state to speed up display operations. Yes: Toggle the CS pin, other devices with their own CS pin can use the SPI bus. No: Activate the CS pin and leave it that way, faster but less flexible. | |
|
|
CS |
| Chip select pin used to activate the SPI bus on the display ready to receive commands. Allows multiple devices each with their own unique CS pin to be sat on the same SPI bus. | |
|
|
Use Reset |
| Decides if the reset pin is driven using an I/O pin. If not driven from a pin then you simply need to connect the reset line to VCC to enable the display. | |
|
|
Reset |
| Reset pin used to reset the display as part of the initialise function. | |
|
|
Fonts |
|
|
Font Count |
| Specifies the number of fonts available to use on the display. | |
|
|
Font 0 |
|
|
Font |
| Font picker to decide which font to use on your display. | |
|
Bytes Required |
| Number of bytes required in program memory to store the selected font. | |
|
|
Character Spacing |
| Sets the number of blank pixels between each character when printing text. | |
|
|
Space Width |
| Sets the number of horizontal pixels used to represent a space character. | |
|
|
Simulation |
|
|
Component Label |
|
Component Label Scale |
| The label scale can be change if the amout of text is too wide for the display | |
|
|
Physical Orientation |
| Rotates the simulated canvas to match the orientation of real world hardware. | |
Component Source Code
Please click here to download the component source project: FC_Comp_Source_GLCD_SSD1331.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_GLCD_SSD1331.fcfx