canvas.h

Go to the documentation of this file.

/*
    MIT License

    Copyright 2018-2020,2022 (C) Alexey Dynda

    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 _NANO_CANVAS_H_
#define _NANO_CANVAS_H_

#include "point.h"
#include "rect.h"
#include "font.h"
#include "canvas_types.h"

template <uint8_t BPP> class NanoCanvasOps
{
public:
    typedef NanoCanvasOps<BPP> T;

    static const uint8_t BITS_PER_PIXEL = BPP;

    NanoPoint offset;

    NanoCanvasOps()
    {
    }

    NanoCanvasOps(lcdint_t w, lcdint_t h, uint8_t *bytes)
    {
        begin(w, h, bytes);
    }

    void begin(lcdint_t w, lcdint_t h, uint8_t *bytes);

    void setOffset(lcdint_t ox, lcdint_t oy)
    {
        offset.x = ox;
        offset.y = oy;
    };

    const NanoPoint offsetEnd() const
    {
        return offset + (NanoPoint){(lcdint_t)(m_w - 1), (lcdint_t)(m_h - 1)};
    }

    const NanoRect rect() const
    {
        return {offset, offsetEnd()};
    }

    void putPixel(lcdint_t x, lcdint_t y);

    void putPixel(const NanoPoint &p);

    void drawVLine(lcdint_t x1, lcdint_t y1, lcdint_t y2);

    void drawHLine(lcdint_t x1, lcdint_t y1, lcdint_t x2);

    void drawLine(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2);

    void drawLine(const NanoRect &rect);

    void drawRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline));

    void drawRect(const NanoRect &rect);

    void fillRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline));

    void fillRect(const NanoRect &rect);

    void drawCircle(lcdint_t x, lcdint_t y, lcdint_t r, uint8_t options = 0x0F) __attribute__((noinline));

    void drawBitmap1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));

    void drawBitmap8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));

    void drawBitmap16(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap)
        __attribute__((noinline));

    void clear() __attribute__((noinline));

    size_t write(uint8_t c);

    uint8_t printChar(uint8_t c);

    void printFixed(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style = STYLE_NORMAL)
        __attribute__((noinline));

    void printFixedPgm(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style = STYLE_NORMAL);

    void setMode(uint8_t modeFlags)
    {
        m_textMode = modeFlags;
    };

    void setColor(uint16_t color)
    {
        m_color = color;
    }

    uint16_t getColor()
    {
        return m_color;
    }

    void invertColors()
    {
        uint16_t color = m_color;
        m_color = m_bgColor;
        m_bgColor = color;
    }

    void setBackground(uint16_t color)
    {
        m_bgColor = color;
    }

    void setFont(NanoFont &font)
    {
        m_font = &font;
    };

    NanoFont &getFont()
    {
        return *m_font;
    }

    void setFontSpacing(uint8_t spacing)
    {
        if ( m_font )
            m_font->setSpacing(spacing);
    }

    void setFixedFont(const uint8_t *progmemFont)
    {
        g_canvas_font.loadFixedFont(progmemFont);
        setFont(g_canvas_font);
    }

    void setFreeFont(const uint8_t *progmemFont, const uint8_t *secondaryFont = nullptr)
    {
        (void)(secondaryFont);
        g_canvas_font.loadFreeFont(progmemFont);
        setFont(g_canvas_font);
    }

    uint8_t *getData()
    {
        return m_buf;
    }

    lcduint_t width()
    {
        return m_w;
    }

    lcduint_t height()
    {
        return m_h;
    }

    void rotateCW(T &out);

protected:
    lcduint_t m_w;              
    lcduint_t m_h;              
    lcdint_t m_cursorX;         
    lcdint_t m_cursorY;         
    uint8_t m_textMode;         
    EFontStyle m_fontStyle;     
    uint8_t *m_buf;             
    uint16_t m_color;           
    uint16_t m_bgColor;         
    NanoFont *m_font = nullptr; 
};

template <uint8_t BPP> class NanoCanvasBase: public NanoCanvasOps<BPP>
{
public:
    using NanoCanvasOps<BPP>::NanoCanvasOps;
};

template <lcduint_t W, lcduint_t H, uint8_t BPP> class NanoCanvas: public NanoCanvasBase<BPP>
{
public:
    NanoCanvas()
        : NanoCanvasBase<BPP>(W, H, m_buffer)
    {
    }

private:
    uint8_t m_buffer[W * H * BPP / 8]{};
};

//
//                             1-BIT GRAPHICS
//

enum
{
    BLACK = 0x00, 
    WHITE = 0xFF, 
};

class NanoCanvas1: public NanoCanvasBase<1>
{
public:
    using NanoCanvasBase::NanoCanvasBase;
};

class NanoCanvas1_8: public NanoCanvasBase<1>
{
public:
    using NanoCanvasBase::NanoCanvasBase;
};

class NanoCanvas1_16: public NanoCanvasBase<1>
{
public:
    using NanoCanvasBase::NanoCanvasBase;
};

//
//                             8-BIT GRAPHICS
//

class NanoCanvas4: public NanoCanvasBase<4>
{
public:
    using NanoCanvasBase::NanoCanvasBase;
};

//
//                             8-BIT GRAPHICS
//

class NanoCanvas8: public NanoCanvasBase<8>
{
public:
    using NanoCanvasBase::NanoCanvasBase;
};

//
//                             16-BIT GRAPHICS
//

class NanoCanvas16: public NanoCanvasBase<16>
{
public:
    using NanoCanvasBase::NanoCanvasBase;
};

#endif