Merge branch 'main' into ExampleWorkOver

Author: Kirk Benell

docs/api_graphics.md

@@ -124,6 +124,26 @@ Draws a bitmap on the screen.
 
 The bitmap should be 8 bit encoded - each pixel contains 8 y values.
 
+```c++
+void bitmap(uint8_t x0, uint8_t y0, uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height )
+```
+
+| Parameter | Type | Description |
+| :--- | :--- | :--- |
+| x0 | `uint8_t` | The X coordinate to place the bitmap - upper left corner|
+| y0 | `uint8_t` | The Y coordinate to place the bitmap - upper left corner|
+| pBitmap | `uint8_t *` | A pointer to the bitmap array|
+| bmp_width | `uint8_t` | The width of the bitmap|
+| bmp_height | `uint8_t` | The height of the bitmap|
+
+### bitmap()
+
+Draws a bitmap on the screen.
+
+The bitmap should be 8 bit encoded - each pixel contains 8 y values.
+
+The coordinate [x1,y1] allows for only a portion of bitmap to be drawn. 
+
 ```c++
 void bitmap(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, 
 				uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height )

examples/Example-01_Hello/Example-01_Hello.ino

@@ -1,18 +1,10 @@
 /*
+
   Example-01_Hello.ino
 
   This demo shows the basic setup of the OLED library, generating simple graphics and displaying
   the results on the target device.
 
-  This is a library written for SparkFun Qwiic OLED boards that use the SSD1306.
-
-  This library configures and draws graphics to OLED boards that use the
-  SSD1306 display hardware. The library only supports I2C.
-
-  SparkFun sells these at its website: www.sparkfun.com
-
-  Do you like this library? Help support SparkFun. Buy a board!
-
    Micro OLED             https://www.sparkfun.com/products/14532
    Transparent OLED       https://www.sparkfun.com/products/15173
    "Narrow" OLED          https://www.sparkfun.com/products/17153
@@ -30,13 +22,17 @@
 
 #include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
 
+// Add in our font descriptor -- so we can center the text on the scren
+#include <res/qw_fnt_5x7.h>
+
 // The Library supports three different types of SparkFun boards. The demo uses the following
 // defines to determine which device is being used. Uncomment the device being used for this demo.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
 
+
 void setup()
 {
     Serial.begin(115200);
@@ -60,14 +56,13 @@ void setup()
 
     String hello = "hello"; // our message
 
-    // Let's center our message on the screen. We need the current font.
-
-    QwiicFont *pFont = myOLED.getFont();
+    // Center our message on the screen. Use our Font Descriptor: QW_FONT_5X7, the default
+    // font of the system.
 
-    // Starting x position - width minus string length (font width * number of characters) / 2
-    int x0 = (myOLED.getWidth() - pFont->width * hello.length()) / 2;
+    // starting x position - width minus string length (font width * number of characters) / 2
+    int x0 = (myOLED.getWidth() - QW_FONT_5X7.width * hello.length()) / 2;
 
-    int y0 = (myOLED.getHeight() - pFont->height) / 2;
+    int y0 = (myOLED.getHeight() - QW_FONT_5X7.height) / 2;
 
     // Draw the text - color of black (0)
     myOLED.text(x0, y0, hello, 0);

library.properties

@@ -5,5 +5,5 @@ maintainer=SparkFun Electronics <sparkfun.com>
 sentence=Library for SparkFun Qwiic OLED Breakout Baords</a>.
 paragraph=Library for all SparkFun Qwiic OLED Boards: Micro OLED, Transparent OLED, Qwiic OLED (128x32), smol Display
 category=Display
-url=https://github.com/sparkfun/SparkFun_Qwiic_OLED_Graphics_Library
+url=https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library
 architectures=*

src/SparkFun_Qwiic_OLED.h

@@ -563,8 +563,10 @@ class QwiicOLEDBaseClass : public Print
     // ---------    -----------------------------
     // x0           The X coordinate to place the bitmap - upper left corner
     // y0           The Y coordinate to place the bitmap - upper left corner
-    // x1           The end X coordinate of the bitmap - lower right corner
-    // y1           The end Y coordinate of the bitmap - lower right corner
+    // x1           The end X coordinate of area to draw - lower right corner
+    //              Range will not exceed bitmap width
+    // y1           The end Y coordinate of area to draw - lower right corner
+    //              Range will not exceed bitmap height
     // pBitmap      A pointer to the bitmap array
     // bmp_width    The width of the bitmap
     // bmp_height   The height of the bitmap
@@ -577,8 +579,25 @@ class QwiicOLEDBaseClass : public Print
 
     ///////////////////////////////////////////////////////////////////////
     // bitmap()
+    // 
+    // Draws a bitmap on the screen.
     //
-    // Draws a bitmap object on the screen.
+    // Parameter    Description
+    // ---------    -----------------------------
+    // x0           The X coordinate to place the bitmap - upper left corner
+    // y0           The Y coordinate to place the bitmap - upper left corner
+    // pBitmap      A pointer to the bitmap array
+    // bmp_width    The width of the bitmap
+    // bmp_height   The height of the bitmap
+
+    void bitmap(uint8_t x0, uint8_t y0, uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height ){
+
+        _device.bitmap(x0, y0, pBitmap, bmp_width, bmp_height);
+    }
+    ///////////////////////////////////////////////////////////////////////
+    // bitmap()
+    // 
+    // Draws a bitmap object on the screen. 
     //
     // Parameter    Description
     // ---------    -----------------------------

src/qwiic_grbuffer.cpp

@@ -531,10 +531,20 @@ void QwGrBufferDevice::draw_circle_filled(uint8_t x0, uint8_t y0, uint8_t radius
 void QwGrBufferDevice::bitmap(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1,
                               uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height)
 {
-
     (*_idraw.draw_bitmap)(this, x0, y0, x1, y1, pBitmap, bmp_width, bmp_height);
 }
 
+////////////////////////////////////////////////////////////////////////////////////////
+// bitmap()
+//
+// Draw a bitmap on the screen
+
+void QwGrBufferDevice::bitmap(uint8_t x0, uint8_t y0, uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height )
+{
+
+    (*_idraw.draw_bitmap)(this, x0, y0, bmp_width, bmp_height, pBitmap, bmp_width, bmp_height);
+}
+
 ////////////////////////////////////////////////////////////////////////////////////////
 // bitmap() - use a bitmap object
 //

src/qwiic_grbuffer.h

@@ -192,8 +192,13 @@ class QwGrBufferDevice : protected _QwIDraw
     void rectangle(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, uint8_t clr = 1);
     void rectangle_fill(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, uint8_t clr = 1);
 
-    void bitmap(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1,
-                uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height);
+
+    void bitmap(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, 
+                uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height );
+
+    // draw full bitmap
+    void bitmap(uint8_t x0, uint8_t y0, uint8_t *pBitmap, uint8_t bmp_width, uint8_t bmp_height );
+
     // Bitmap draw - using a bitmap object
     void bitmap(uint8_t x0, uint8_t y0, QwBitmap &bitmap);