fleg
/
Arduboy2
mirror of https://github.com/MLXXXp/Arduboy2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document bitmap image height requirements 

Added the requirement that bitmap heights must be a multiple of
8 pixels in the documentation for drawBitmap() and drawCompressed().
This commit is contained in:
Scott Allen 2020-09-28 15:25:18 -04:00
parent 014e6e0a8b
commit 191e9a2e45
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/Arduboy2.h
View File

@ -690,7 +690,7 @@ class Arduboy2Base : public Arduboy2Core
* \param y The Y coordinate of the top left pixel affected by the bitmap. * \param y The Y coordinate of the top left pixel affected by the bitmap.
* \param bitmap A pointer to the bitmap array in program memory. * \param bitmap A pointer to the bitmap array in program memory.
* \param w The width of the bitmap in pixels. * \param w The width of the bitmap in pixels.
* \param h The height of the bitmap in pixels. * \param h The height of the bitmap in pixels. Must be a multiple of 8.
* \param color The color of pixels for bits set to 1 in the bitmap. * \param color The color of pixels for bits set to 1 in the bitmap.
* If the value is INVERT, bits set to 1 will invert the * If the value is INVERT, bits set to 1 will invert the
* corresponding pixel. (optional; defaults to WHITE). * corresponding pixel. (optional; defaults to WHITE).
@ -701,7 +701,8 @@ class Arduboy2Base : public Arduboy2Core
* corresponding pixel will be left unchanged. * corresponding pixel will be left unchanged.
* *
* Each byte in the array specifies a vertical column of 8 pixels, with the * Each byte in the array specifies a vertical column of 8 pixels, with the
* least significant bit at the top. * least significant bit at the top. The height of the image must be a
* multiple of 8 pixels (8, 16, 24, 32, ...). The width can be any size.
* *
* The array must be located in program memory by using the PROGMEM modifier. * The array must be located in program memory by using the PROGMEM modifier.
* *
@ -753,6 +754,9 @@ class Arduboy2Base : public Arduboy2Core
* Draw a bitmap starting at the given coordinates using an array that has * Draw a bitmap starting at the given coordinates using an array that has
* been compressed using an RLE algorthm implemented by Team A.R.G. * been compressed using an RLE algorthm implemented by Team A.R.G.
* *
* The height of the image must be a multiple of 8 pixels (8, 16, 24,
* 32, ...). The width can be any size.
*
* Bits set to 1 in the provided bitmap array (after decoding) will have * Bits set to 1 in the provided bitmap array (after decoding) will have
* their corresponding pixel set to the specified color. For bits set to 0 * their corresponding pixel set to the specified color. For bits set to 0
* in the array, the corresponding pixel will be left unchanged. * in the array, the corresponding pixel will be left unchanged.