Difference between revisions of "Component: GLCD Bitmap Drawer FAT (Graphical Library)"
From Flowcode Help
Jump to navigationJump to searchLine 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
− | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
+ | |||
+ | |||
Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
+ | |||
+ | |||
Line 42: | Line 46: | ||
==Macro reference== | ==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;" | '''GetHeight''' | ||
+ | |- | ||
+ | | colspan="2" | Returns the height of the loaded bitmap file in pixels. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Filename | ||
+ | |- | ||
+ | | colspan="2" | The filename of the bitmap we want to measure | ||
+ | |- | ||
+ | | 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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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;" | '''GetWidth''' | ||
+ | |- | ||
+ | | colspan="2" | Returns the width of the loaded bitmap file in pixels. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Filename | ||
+ | |- | ||
+ | | colspan="2" | The filename of the bitmap we want to measure | ||
+ | |- | ||
+ | | 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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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;" | '''SetTransparentColour''' | ||
+ | |- | ||
+ | | colspan="2" | Sets the transparency colour, the colour that is not drawn when transparency is enabled. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | R | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | G | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | B | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | 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;" | '''Display_BMP''' | ||
+ | |- | ||
+ | | colspan="2" | Draws the bitmap image from ROM onto the display at the corrdinates X and Y. Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Filename | ||
+ | |- | ||
+ | | colspan="2" | Bitmap file to open from current directory on SD card 8.3 format | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | X | ||
+ | |- | ||
+ | | colspan="2" | X Axis coordinate, specifies the location of the left edge of the bitmap image | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | Y | ||
+ | |- | ||
+ | | colspan="2" | Y Axis coordinate, specifies the location of the top edge of the bitmap image | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Orientation | ||
+ | |- | ||
+ | | colspan="2" | 0=Normal, 1=90 Degrees CW, 2=180 Degrees, 3=270 Degrees CW | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Transparency | ||
+ | |- | ||
+ | | colspan="2" | 0=Off, 1=On Don't Draw Any Pixels which match the transparent colour | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Flip | ||
+ | |- | ||
+ | | colspan="2" | 0=Normal, 1=FlipWidth, 2=FlipHeight, 3=FlipBoth | ||
+ | |- | ||
+ | | 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;" | '''Display_BMP_Fast''' | ||
+ | |- | ||
+ | | colspan="2" | Draws the bitmap image from ROM onto the display at the corrdinates X and Y. Attempts to draw a row at a time by not forcing coordinates for every pixel so may not work on some displays. Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Filename | ||
+ | |- | ||
+ | | colspan="2" | Bitmap file to open from current directory on SD card 8.3 format | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | X | ||
+ | |- | ||
+ | | colspan="2" | X Axis coordinate, specifies the location of the left edge of the bitmap image | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | Y | ||
+ | |- | ||
+ | | colspan="2" | Y Axis coordinate, specifies the location of the top edge of the bitmap image | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Orientation | ||
+ | |- | ||
+ | | colspan="2" | 0=Normal, 1=90 Degrees CW, 2=180 Degrees, 3=270 Degrees CW | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Transparency | ||
+ | |- | ||
+ | | colspan="2" | 0=Off, 1=On Don't Draw Any Pixels which match the transparent colour | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Flip | ||
+ | |- | ||
+ | | colspan="2" | 0=Normal, 1=FlipWidth, 2=FlipHeight, 3=FlipBoth | ||
+ | |- | ||
+ | | 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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==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" | [[File:Fc9-type-16-icon.png]] | ||
+ | | width="90%" | GLCD LinkTo | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
+ | | width="90%" | File LinkTo | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
+ | | width="90%" | ColourDisplay | ||
+ | |- | ||
+ | | colspan="2" | Automatically detects if the graphical LCD object is colour or monochrome | ||
+ | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
Revision as of 09:58, 27 January 2023
Author | Matrix TSL |
Version | 2.2 |
Category | Graphical Library |
Contents
GLCD Bitmap Drawer FAT component
A component to simplify the process of drawing bitmap images to a graphical display. Reads Bitmap files directly from a SD card formatted with a FAT file system. Compatible with 24-bit & Monochrome Bitmaps. The gLCD object property specifies which LCD component to draw the bitmap to. Compatible with GLCD, NeoPixel, MIACv3, HT16K33
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Lib_Draw_Bitmap_FAT.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
GetHeight | |
Returns the height of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
GetWidth | |
Returns the width of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
SetTransparentColour | |
Sets the transparency colour, the colour that is not drawn when transparency is enabled. | |
- BYTE | R |
- BYTE | G |
- BYTE | B |
- VOID | Return |
Property reference
Properties | |
GLCD LinkTo | |
File LinkTo | |
ColourDisplay | |
Automatically detects if the graphical LCD object is colour or monochrome |
==Macro reference==
GetHeight | |
Returns the height of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
GetWidth | |
Returns the width of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
SetTransparentColour | |
Sets the transparency colour, the colour that is not drawn when transparency is enabled. | |
- BYTE | R |
- BYTE | G |
- BYTE | B |
- VOID | Return |
Property reference
Properties | |
GLCD LinkTo | |
File LinkTo | |
ColourDisplay | |
Automatically detects if the graphical LCD object is colour or monochrome |
==Macro reference==
GetHeight | |
Returns the height of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
GetWidth | |
Returns the width of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
SetTransparentColour | |
Sets the transparency colour, the colour that is not drawn when transparency is enabled. | |
- BYTE | R |
- BYTE | G |
- BYTE | B |
- VOID | Return |
Property reference
Properties | |
GLCD LinkTo | |
File LinkTo | |
ColourDisplay | |
Automatically detects if the graphical LCD object is colour or monochrome |
==Macro reference==
GetHeight | |
Returns the height of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
GetWidth | |
Returns the width of the loaded bitmap file in pixels. | |
- STRING | Filename |
The filename of the bitmap we want to measure | |
- UINT | Return |
SetTransparentColour | |
Sets the transparency colour, the colour that is not drawn when transparency is enabled. | |
- BYTE | R |
- BYTE | G |
- BYTE | B |
- VOID | Return |
Property reference
Properties | |
GLCD LinkTo | |
File LinkTo | |
ColourDisplay | |
Automatically detects if the graphical LCD object is colour or monochrome |