Allow 4bpp Sprites to be rotated

4bpp Sprites can now be pushed to the TFT with a rotation

Extensions/Sprite.cpp

@@ -59,8 +59,6 @@ void* TFT_eSprite::createSprite(int16_t w, int16_t h, uint8_t frames)
   _iwidth  = _dwidth  = _bitwidth = w;
   _iheight = _dheight = h;
 
-  _colorMap = nullptr;
-
   this->cursor_x = 0;
   this->cursor_y = 0;
 
@@ -94,6 +92,8 @@ void* TFT_eSprite::createSprite(int16_t w, int16_t h, uint8_t frames)
     _img8_2 = _img8 + (w * h + 1);
   }
 
+  if ( (_bpp == 4) && (_colorMap == nullptr)) createPalette(default_4bit_palette);
+
   // This is to make it clear what pointer size is expected to be used
   // but casting in the user sketch is needed due to the use of void*
   if ( (_bpp == 1) && (frames > 1) )
@@ -195,7 +195,7 @@ void* TFT_eSprite::callocSprite(int16_t w, int16_t h, uint8_t frames)
 ** Description:             Set a palette for a 4-bit per pixel sprite
 *************************************************************************************x*/
 
-void TFT_eSprite::createPalette(uint16_t colorMap[], int colors)
+void TFT_eSprite::createPalette(uint16_t colorMap[], uint8_t colors)
 {
   if (_colorMap != nullptr)
   {
@@ -204,14 +204,18 @@ void TFT_eSprite::createPalette(uint16_t colorMap[], int colors)
 
   if (colorMap == nullptr)
   {
-    return; // do nothing other than clear the existing map
+    // Create a color map using the default FLASH map
+    createPalette(default_4bit_palette);
+    return;
   }
 
-  // allocate color map
+  // Allocate and clear memory for 16 color map
   _colorMap = (uint16_t *)calloc(16, sizeof(uint16_t));
-  if (colors > 16)
-    colors = 16;
-  for (auto i = 0; i < colors; i++)
+
+  if (colors > 16) colors = 16;
+  
+  // Copy map colors
+  for (uint8_t i = 0; i < colors; i++)
   {
     _colorMap[i] = colorMap[i];
   }
@@ -222,7 +226,7 @@ void TFT_eSprite::createPalette(uint16_t colorMap[], int colors)
 ** Description:             Set a palette for a 4-bit per pixel sprite
 *************************************************************************************x*/
 
-void TFT_eSprite::createPalette(const uint16_t colorMap[], int colors)
+void TFT_eSprite::createPalette(const uint16_t colorMap[], uint8_t colors)
 {
   if (_colorMap != nullptr)
   {
@@ -231,14 +235,17 @@ void TFT_eSprite::createPalette(const uint16_t colorMap[], int colors)
 
   if (colorMap == nullptr)
   {
-    return; // do nothing other than clear the existing map
+    // Create a color map using the default FLASH map
+    colorMap = default_4bit_palette;
   }
 
-  // allocate color map
+  // Allocate and clear memory for 16 color map
   _colorMap = (uint16_t *)calloc(16, sizeof(uint16_t));
-  if (colors > 16)
-    colors = 16;
-  for (auto i = 0; i < colors; i++)
+
+  if (colors > 16) colors = 16;
+
+  // Copy map colors
+  for (uint8_t i = 0; i < colors; i++)
   {
     _colorMap[i] = pgm_read_word(colorMap++);
   }
@@ -306,7 +313,7 @@ int8_t TFT_eSprite::getColorDepth(void)
 
 /***************************************************************************************
 ** Function name:           setBitmapColor
-** Description:             Set the foreground foreground and background colour
+** Description:             Set the 1bpp foreground foreground and background colour
 ***************************************************************************************/
 void TFT_eSprite::setBitmapColor(uint16_t c, uint16_t b)
 {
@@ -317,23 +324,22 @@ void TFT_eSprite::setBitmapColor(uint16_t c, uint16_t b)
 
 /***************************************************************************************
 ** Function name:           setPaletteColor
-** Description:             Set the palette color at the given index
+** Description:             Set the 4bpp palette color at the given index
 ***************************************************************************************/
 void TFT_eSprite::setPaletteColor(uint8_t index, uint16_t color)
 {
-  if (_colorMap == nullptr || index > 15)
-    return; // out of bounds
+  if (_colorMap == nullptr || index > 15) return; // out of bounds
+
   _colorMap[index] = color;
 }
 
 /***************************************************************************************
 ** Function name:           getPaletteColor
-** Description:             Return the palette color at index, or 0 (black) on error.
+** Description:             Return the palette color at 4bpp index, or 0 on error.
 ***************************************************************************************/
 uint16_t TFT_eSprite::getPaletteColor(uint8_t index)
 {
-  if (_colorMap == nullptr || index > 15)
-    return 0;
+  if (_colorMap == nullptr || index > 15) return 0; // out of bounds
 
   return _colorMap[index];
 }
@@ -395,7 +401,7 @@ int16_t TFT_eSprite::getPivotY(void)
 #define FP_SCALE 10
 bool TFT_eSprite::pushRotated(int16_t angle, int32_t transp)
 {
-  if ( !_created || _bpp == 4) return false;
+  if ( !_created) return false;
 
   // Bounding box parameters
   int16_t min_x;
@@ -413,6 +419,7 @@ bool TFT_eSprite::pushRotated(int16_t angle, int32_t transp)
   uint32_t xe = _iwidth << FP_SCALE;
   uint32_t ye = _iheight << FP_SCALE;
   uint32_t tpcolor = transp;  // convert to unsigned
+  if (_bpp == 4) tpcolor = _colorMap[transp & 0x0F];
 
   _tft->startWrite(); // Avoid transaction overhead for every tft pixel
 
@@ -461,9 +468,10 @@ bool TFT_eSprite::pushRotated(int16_t angle, int32_t transp)
 ** Function name:           pushRotated - Fast fixed point integer maths version
 ** Description:             Push a rotated copy of the Sprite to another Sprite
 *************************************************************************************x*/
+// Not compatible with 4bpp
 bool TFT_eSprite::pushRotated(TFT_eSprite *spr, int16_t angle, int32_t transp)
 {
-  if ( !_created  || _bpp == 4) return false;       // Check this Sprite is created
+  if ( !_created  || _bpp == 4) return false; // Check this Sprite is created
   if ( !spr->_created  || spr->_bpp == 4) return false;  // Ckeck destination Sprite is created
 
   // Bounding box parameters
@@ -658,12 +666,8 @@ void TFT_eSprite::pushSprite(int32_t x, int32_t y)
   }
   else if (_bpp == 4)
   {
-    if (_colorMap == nullptr) {
-      return;
-    }
     _tft->pushImage(x, y, _dwidth, _dheight, _img4, false, _colorMap);
   }
-
   else _tft->pushImage(x, y, _dwidth, _dheight, _img8, (bool)(_bpp == 8));
 }