canvas_types.h

Go to the documentation of this file.

/*
    MIT License

    Copyright (c) 2017-2020, 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.
*/
#pragma once

#include "canvas/UserSettings.h"

#if defined(ARDUINO)
#include <Arduino.h>
#elif defined(__AVR__)
#include <avr/pgmspace.h>
#else
#endif

#include <stdint.h>
#include <stddef.h>

#define SSD1306_MORE_CHARS_REQUIRED 0xffff

#ifndef DOXYGEN_SHOULD_SKIP_THIS
#ifndef PROGMEM
#define PROGMEM
#endif
#endif

#define RGB_COLOR8(r, g, b) ((r & 0xE0) | ((g >> 3) & 0x1C) | (b >> 6))

#define GRAY_COLOR4(gray) (((gray >> 4) & 0x0F) | (gray & 0xF0))

#define RGB_COLOR4(r, g, b) ((r >> 2) + (g >> 1) + (b >> 2))

#define RGB8_TO_GRAY4(rgb) ((rgb >> 6) + ((rgb >> 2) & 0x07) + (rgb & 0x03))

#define RGB_COLOR16(r, g, b) (((r << 8) & 0xF800) | ((g << 3) & 0x07E0) | (b >> 3))

#define RGB8_TO_RGB16(c)                                                                                               \
    ((((uint16_t)c & 0b11100000) << 8) | (((uint16_t)c & 0b00011100) << 6) | (((uint16_t)c & 0b00000011) << 3))

#define RGB16_TO_RGB8(c)                                                                                               \
    (((uint16_t)(c >> 8) & 0b11100000) | ((uint16_t)(c >> 6) & 0b00011100) | ((uint16_t)(c >> 3) & 0b00000011))

#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) ||                             \
    defined(__AVR_ATtiny24__) || defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny84__)

typedef int8_t lcdint_t;
typedef uint8_t lcduint_t;
#else

typedef int lcdint_t;
typedef unsigned int lcduint_t;
#endif

typedef enum
{
    STYLE_NORMAL,
    STYLE_BOLD,
    STYLE_ITALIC,
} EFontStyle;

enum
{
    CANVAS_MODE_BASIC = 0x00,
    CANVAS_TEXT_WRAP = 0x01,
    CANVAS_MODE_TRANSPARENT = 0x02,
    CANVAS_TEXT_WRAP_LOCAL = 0x04,
};

typedef enum
{
    FONT_SIZE_NORMAL = 0,
    FONT_SIZE_2X = 1,
    FONT_SIZE_4X = 2,
    FONT_SIZE_8X = 3,
} EFontSize;

#pragma pack(push, 1)

typedef struct
{
    uint8_t type;         
    uint8_t width;        
    uint8_t height;       
    uint8_t ascii_offset; 
} SFontHeaderRecord;
#pragma pack(pop)

typedef struct
{
    SFontHeaderRecord h;          
    uint8_t count;                
    uint8_t pages;                
    uint8_t glyph_size;           
    uint8_t spacing;              
    const uint8_t *primary_table; 
#ifdef CONFIG_SSD1306_UNICODE_ENABLE
    const uint8_t *secondary_table; 
#endif
} SFixedFontInfo;

typedef struct
{
    uint8_t width;        
    uint8_t height;       
    uint8_t spacing;      
    const uint8_t *glyph; 
} SCharInfo;

typedef struct
{
    const char **items;
    uint8_t count;
    uint8_t selection;
    uint8_t oldSelection;
    uint8_t scrollPosition;
    lcdint_t top;
    lcdint_t left;
    lcduint_t width;
    lcduint_t height;
} SAppMenu;