MiniR4_GFX.h

Go to the documentation of this file.

 
/*
The MIT License (MIT)
 
Copyright (c) 2017 Adafruit Industries
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef _ADAFRUIT_GFX_H
#define _ADAFRUIT_GFX_H
 
#if ARDUINO >= 100
#    include "Arduino.h"
#    include "Print.h"
#else
#    include "WProgram.h"
#endif
#include "MiniR4_gfxfont.h"
 
#include "MiniR4_I2CDevice.h"
 
class Adafruit_GFX : public Print
{
 
public:
    Adafruit_GFX(int16_t w, int16_t h);   // Constructor
 
    /**********************************************************************/
    /**********************************************************************/
    virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;
 
    // TRANSACTION API / CORE DRAW API
    // These MAY be overridden by the subclass to provide device-specific
    // optimized code.  Otherwise 'generic' versions are used.
    virtual void startWrite(void);
    virtual void writePixel(int16_t x, int16_t y, uint16_t color);
    virtual void writeFillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
    virtual void writeFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    virtual void writeFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    virtual void writeLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
    virtual void endWrite(void);
 
    // CONTROL API
    // These MAY be overridden by the subclass to provide device-specific
    // optimized code.  Otherwise 'generic' versions are used.
    virtual void setRotation(uint8_t r);
    virtual void invertDisplay(bool i);
 
    // BASIC DRAW API
    // These MAY be overridden by the subclass to provide device-specific
    // optimized code.  Otherwise 'generic' versions are used.
 
    // It's good to implement those, even if using transaction API
    virtual void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    virtual void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    virtual void fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
    virtual void fillScreen(uint16_t color);
    // Optional and probably not necessary to change
    virtual void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
    virtual void drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
 
    // These exist only with Adafruit_GFX (no subclass overrides)
    void drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
    void drawCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername, uint16_t color);
    void fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
    void fillCircleHelper(
        int16_t x0, int16_t y0, int16_t r, uint8_t cornername, int16_t delta, uint16_t color);
    void drawTriangle(
        int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
    void fillTriangle(
        int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
    void drawRoundRect(
        int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
    void fillRoundRect(
        int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
    void drawBitmap(
        int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color);
    void drawBitmap(
        int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color,
        uint16_t bg);
    void drawBitmap(int16_t x, int16_t y, uint8_t* bitmap, int16_t w, int16_t h, uint16_t color);
    void drawBitmap(
        int16_t x, int16_t y, uint8_t* bitmap, int16_t w, int16_t h, uint16_t color, uint16_t bg);
    void drawXBitmap(
        int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color);
    void drawGrayscaleBitmap(int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h);
    void drawGrayscaleBitmap(int16_t x, int16_t y, uint8_t* bitmap, int16_t w, int16_t h);
    void drawGrayscaleBitmap(
        int16_t x, int16_t y, const uint8_t bitmap[], const uint8_t mask[], int16_t w, int16_t h);
    void drawGrayscaleBitmap(
        int16_t x, int16_t y, uint8_t* bitmap, uint8_t* mask, int16_t w, int16_t h);
    void drawRGBBitmap(int16_t x, int16_t y, const uint16_t bitmap[], int16_t w, int16_t h);
    void drawRGBBitmap(int16_t x, int16_t y, uint16_t* bitmap, int16_t w, int16_t h);
    void drawRGBBitmap(
        int16_t x, int16_t y, const uint16_t bitmap[], const uint8_t mask[], int16_t w, int16_t h);
    void drawRGBBitmap(int16_t x, int16_t y, uint16_t* bitmap, uint8_t* mask, int16_t w, int16_t h);
    void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size);
    void drawChar(
        int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size_x,
        uint8_t size_y);
    void getTextBounds(
        const char* string, int16_t x, int16_t y, int16_t* x1, int16_t* y1, uint16_t* w,
        uint16_t* h);
    void getTextBounds(
        const __FlashStringHelper* s, int16_t x, int16_t y, int16_t* x1, int16_t* y1, uint16_t* w,
        uint16_t* h);
    void getTextBounds(
        const String& str, int16_t x, int16_t y, int16_t* x1, int16_t* y1, uint16_t* w,
        uint16_t* h);
    void setTextSize(uint8_t s);
    void setTextSize(uint8_t sx, uint8_t sy);
    void setFont(const GFXfont* f = NULL);
 
    /**********************************************************************/
    /**********************************************************************/
    void setCursor(int16_t x, int16_t y)
    {
        cursor_x = x;
        cursor_y = y;
    }
 
    /**********************************************************************/
    /**********************************************************************/
    void setTextColor(uint16_t c) { textcolor = textbgcolor = c; }
 
    /**********************************************************************/
    /**********************************************************************/
    void setTextColor(uint16_t c, uint16_t bg)
    {
        textcolor   = c;
        textbgcolor = bg;
    }
 
    /**********************************************************************/
    /**********************************************************************/
    void setTextWrap(bool w) { wrap = w; }
 
    /**********************************************************************/
    /**********************************************************************/
    void cp437(bool x = true) { _cp437 = x; }
 
    using Print::write;
#if ARDUINO >= 100
    virtual size_t write(uint8_t);
#else
    virtual void write(uint8_t);
#endif
 
    /************************************************************************/
    /************************************************************************/
    int16_t width(void) const { return _width; };
 
    /************************************************************************/
    /************************************************************************/
    int16_t height(void) const { return _height; }
 
    /************************************************************************/
    /************************************************************************/
    uint8_t getRotation(void) const { return rotation; }
 
    // get current cursor position (get rotation safe maximum values,
    // using: width() for x, height() for y)
    /************************************************************************/
    /************************************************************************/
    int16_t getCursorX(void) const { return cursor_x; }
 
    /************************************************************************/
    /************************************************************************/
    int16_t getCursorY(void) const { return cursor_y; };
 
protected:
    void charBounds(
        unsigned char c, int16_t* x, int16_t* y, int16_t* minx, int16_t* miny, int16_t* maxx,
        int16_t* maxy);
    int16_t  WIDTH;         
    int16_t  HEIGHT;        
    int16_t  _width;        
    int16_t  _height;       
    int16_t  cursor_x;      
    int16_t  cursor_y;      
    uint16_t textcolor;     
    uint16_t textbgcolor;   
    uint8_t  textsize_x;    
    uint8_t  textsize_y;    
    uint8_t  rotation;      
    bool     wrap;          
    bool     _cp437;        
    GFXfont* gfxFont;       
};
 
class Adafruit_GFX_Button
{
 
public:
    Adafruit_GFX_Button(void);
    // "Classic" initButton() uses center & size
    void initButton(
        Adafruit_GFX* gfx, int16_t x, int16_t y, uint16_t w, uint16_t h, uint16_t outline,
        uint16_t fill, uint16_t textcolor, char* label, uint8_t textsize);
    void initButton(
        Adafruit_GFX* gfx, int16_t x, int16_t y, uint16_t w, uint16_t h, uint16_t outline,
        uint16_t fill, uint16_t textcolor, char* label, uint8_t textsize_x, uint8_t textsize_y);
    // New/alt initButton() uses upper-left corner & size
    void initButtonUL(
        Adafruit_GFX* gfx, int16_t x1, int16_t y1, uint16_t w, uint16_t h, uint16_t outline,
        uint16_t fill, uint16_t textcolor, char* label, uint8_t textsize);
    void initButtonUL(
        Adafruit_GFX* gfx, int16_t x1, int16_t y1, uint16_t w, uint16_t h, uint16_t outline,
        uint16_t fill, uint16_t textcolor, char* label, uint8_t textsize_x, uint8_t textsize_y);
    void drawButton(bool inverted = false);
    bool contains(int16_t x, int16_t y);
 
    /**********************************************************************/
    /**********************************************************************/
    void press(bool p)
    {
        laststate = currstate;
        currstate = p;
    }
 
    bool justPressed();
    bool justReleased();
 
    /**********************************************************************/
    /**********************************************************************/
    bool isPressed(void) { return currstate; };
 
private:
    Adafruit_GFX* _gfx;
    int16_t       _x1, _y1;   // Coordinates of top-left corner
    uint16_t      _w, _h;
    uint8_t       _textsize_x;
    uint8_t       _textsize_y;
    uint16_t      _outlinecolor, _fillcolor, _textcolor;
    char          _label[10];
 
    bool currstate, laststate;
};
 
class GFXcanvas1 : public Adafruit_GFX
{
public:
    GFXcanvas1(uint16_t w, uint16_t h);
    ~GFXcanvas1(void);
    void drawPixel(int16_t x, int16_t y, uint16_t color);
    void fillScreen(uint16_t color);
    void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    bool getPixel(int16_t x, int16_t y) const;
    /**********************************************************************/
    /**********************************************************************/
    uint8_t* getBuffer(void) const { return buffer; }
 
protected:
    bool     getRawPixel(int16_t x, int16_t y) const;
    void     drawFastRawVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    void     drawFastRawHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    uint8_t* buffer;   
 
private:
#ifdef __AVR__
    // Bitmask tables of 0x80>>X and ~(0x80>>X), because X>>Y is slow on AVR
    static const uint8_t PROGMEM GFXsetBit[], GFXclrBit[];
#endif
};
 
class GFXcanvas8 : public Adafruit_GFX
{
public:
    GFXcanvas8(uint16_t w, uint16_t h);
    ~GFXcanvas8(void);
    void    drawPixel(int16_t x, int16_t y, uint16_t color);
    void    fillScreen(uint16_t color);
    void    drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    void    drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    uint8_t getPixel(int16_t x, int16_t y) const;
    /**********************************************************************/
    /**********************************************************************/
    uint8_t* getBuffer(void) const { return buffer; }
 
protected:
    uint8_t  getRawPixel(int16_t x, int16_t y) const;
    void     drawFastRawVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    void     drawFastRawHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    uint8_t* buffer;   
};
 
class GFXcanvas16 : public Adafruit_GFX
{
public:
    GFXcanvas16(uint16_t w, uint16_t h);
    ~GFXcanvas16(void);
    void     drawPixel(int16_t x, int16_t y, uint16_t color);
    void     fillScreen(uint16_t color);
    void     byteSwap(void);
    void     drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    void     drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    uint16_t getPixel(int16_t x, int16_t y) const;
    /**********************************************************************/
    /**********************************************************************/
    uint16_t* getBuffer(void) const { return buffer; }
 
protected:
    uint16_t  getRawPixel(int16_t x, int16_t y) const;
    void      drawFastRawVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
    void      drawFastRawHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
    uint16_t* buffer;   
};
 
#endif   // _ADAFRUIT_GFX_H