Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-10 06:14:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated NeoBitmapFile object API (markdown)

Michael Miller
2019-11-18 11:15:50 -08:00
parent 50bd4dd431
commit e41a9c79b8
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
NeoBitmapFile-object-API.md

@@ -14,7 +14,8 @@ NeoBitmapFile<NeoGrbFeature, File> image;
## Methods ## Methods
### bool Begin(FILE file) ### bool Begin(FILE file)
This will initialize the NeoBitmapFile to use the given file. It will check the contents of the file for a valid image and configure itself to read data from the file. This will initialize the NeoBitmapFile to use the given file. It will check the contents of the file for a valid image and configure itself to read data from the file.
It will return false if the file is not a compatible file format. Currently it requires the file to be BMP, 24 or 32 bit, with no compression. It will return false if the file is not a compatible file format. Currently it requires the file to be BMP, 24 or 32 bit, with no compression.
The `file` instance passed in will be managed by the NeoBitmapFile object so there is no need to close it manually.
### uint16_t PixelSize() const ### uint16_t PixelSize() const
This will return the number of bytes a single pixel takes. This will return the number of bytes a single pixel takes.