Component: GLCD Bitmap Drawer FAT (Graphical Library)

Author	Matrix TSL
Version	3.0
Category	Graphical Library

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

Version information

Library Version, Component Version, Date, Author, Info
20, 1.0, 26-07-24, BR, Added pallet buffer allowing 4,8-bit bitmaps to function

Detailed description

No detailed description exists yet for this component

Examples

Here is an example that will scan for bitmap files in the root of the SD card and display them on a graphical display.

Bitmap Drawer File Demo

The zip file contains the Flowcode project as well as some example bitmap image files taken from Pixabay.

Place the bitmap files in the same folder as the project file for the simulation to work.

Place the bitmap files on the root of the SD card for the embedded hardware to work.

Macro reference

Display_BMP

	Display_BMP
Draws the bitmap image onto the display at the corrdinates X and Y. Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound
- STRING	Filename
Bitmap file to open from current directory on SD card 8.3 format
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- BYTE	Orientation
0=Normal, 1=90 Degrees CW, 2=180 Degrees, 3=270 Degrees CW
- BYTE	Transparency
0=Off, 1=On Don't Draw Any Pixels which match the transparent colour
- BYTE	Flip
0=Normal, 1=FlipWidth, 2=FlipHeight, 3=FlipBoth
- BYTE	Return

Display_BMP_Fast

	Display_BMP_Fast
Draws the bitmap image onto the display at the corrdinates X and Y. Speeds up drawing by not assigning X/Y coordinate for each pixel. Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound
- STRING	Filename
Bitmap file to open from current directory on SD card 8.3 format
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- BOOL	Mode
0=RowByRow, 1=FullWindow(Y Flipped)
- BOOL	Orientation
0=Default, 1=Rotated 90 Degrees (only works with Mode 0)
- BYTE	Return

Display_BMP_Fast_Partial

	Display_BMP_Fast_Partial
Draws a partial bitmap image onto the display at the coordinates X and Y. Speeds up drawing by not assigning X/Y coordinate for each pixel. Allows drawing a percentage of the bitmap width and height from a specified side (top/bottom, left/right). Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound
- STRING	Filename
Bitmap file to open from current directory on SD card 8.3 format
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- BYTE	WidthPercent
Percentage of bitmap width to draw. Range: 0-100
- BYTE	HeightPercent
Percentage of bitmap height to draw. Range: 0-100
- BYTE	HorizontalSide
Which horizontal side to draw from: 0=Left, 1=Right
- BYTE	VerticalSide
Which vertical side to draw from: 0=Top, 1=Bottom
- BOOL	Mode
0=RowByRow, 1=FullWindow(Y Flipped)
- BOOL	Orientation
0=Default, 1=Rotated 90 Degrees (only works with Mode 0)
- BYTE	Return

Display_BMP_Partial

	Display_BMP_Partial
Draws a partial bitmap image onto the display at the coordinates X and Y. Allows drawing a percentage of the bitmap width and height from a specified side (top/bottom, left/right). Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound
- STRING	Filename
Bitmap file to open from current directory on SD card 8.3 format
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- BYTE	WidthPercent
Percentage of bitmap width to draw. Range: 0-100
- BYTE	HeightPercent
Percentage of bitmap height to draw. Range: 0-100
- BYTE	HorizontalSide
Which horizontal side to draw from: 0=Left, 1=Right
- BYTE	VerticalSide
Which vertical side to draw from: 0=Top, 1=Bottom
- BYTE	Orientation
0=Normal, 1=90 Degrees CW, 2=180 Degrees, 3=270 Degrees CW
- BYTE	Transparency
0=Off, 1=On Don't Draw Any Pixels which match the transparent colour
- BYTE	Flip
0=Normal, 1=FlipWidth, 2=FlipHeight, 3=FlipBoth
- BYTE	Return

Display_Scaled_BMP

	Display_Scaled_BMP
Draws the bitmap image onto the display at the corrdinates X and Y. Scales the bitmap to the specified width and height. Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound
- STRING	Filename
Bitmap file to open from current directory on SD card 8.3 format
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- UINT	Width
The size in pixels to draw the bitmap image
- UINT	Height
The size in pixels to draw the bitmap image
- BYTE	Orientation
0=Normal, 1=90 Degrees CW, 2=180 Degrees, 3=270 Degrees CW
- BYTE	Transparency
0=Off, 1=On Don't Draw Any Pixels which match the transparent colour
- BYTE	Flip
0=Normal, 1=FlipWidth, 2=FlipHeight, 3=FlipBoth
- BYTE	Return

Display_Scaled_BMP_Fast

	Display_Scaled_BMP_Fast
Draws the bitmap image onto the display at the corrdinates X and Y. Scales the bitmap to the specified width and height. Speeds up drawing by not assigning X/Y coordinate for each pixel. Return Values: 0=OK, 1=ColourDepthNotSupported, 237=FileNotFound
- STRING	Filename
Bitmap file to open from current directory on SD card 8.3 format
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- UINT	Width
The size in pixels to draw the bitmap image
- UINT	Height
The size in pixels to draw the bitmap image
- BOOL	Mode
0=RowByRow, 1=FullWindow(Y Flipped)
- BOOL	Orientation
0=Default, 1=Rotated 90 Degrees (only works with Mode 0)
- BYTE	Return

GetHeight

	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

	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

	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
	Pallet Buffer
Dedicates an area of RAM to be used as a pallet buffer allowing 4-bit and 8-bit bitmaps to be drawn efficiently. No: No additional RAM is used and only 1-bit and 24-bit bitmaps are supported. Yes: 768 additional bytes of RAM are used and 1-bit, 4-bit, 8-bit and 24-bit bitmaps are supported.
	Use File Index
Allows multiple files to be accessed at once.
	Use File Path
Allows a path to be specified for accessing bitmap files. e.g. Images\

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