gfx_library.h

Go to the documentation of this file.

/*********************************************************************
This is a header file for the gfx library
 
Copyright 2023 Cascoda LTD.
*********************************************************************/
#ifndef GFX_LIBRARY_H
#define GFX_LIBRARY_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/****** Function Declarations for gfx library  ******/
 
void display_drawLine(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint16_t color);
 
void display_drawRect(uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t color);
 
void display_fillRect(uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t color);
 
void display_drawCircle(uint16_t x0, uint16_t y0, uint16_t r, uint16_t color);
 
void display_fillCircle(uint16_t x0, uint16_t y0, uint16_t r, uint16_t color);
 
void display_setCursor(uint16_t x, uint16_t y);
 
void display_setTextSize(uint8_t s);
 
void display_setTextColor(uint16_t c, uint16_t b);
 
void display_putc(uint8_t c);
 
void display_puts(const uint8_t *s);
 
void display_puts_max_n(const uint8_t *s, uint8_t n);
 
void display_double(char *text, int text_size, double v, int decimalDigits);
 
void display_setRotation(uint16_t rotation);
 
uint16_t getCursorX(void);
 
uint16_t getCursorY(void);
 
uint16_t display_getWidth();
 
uint16_t display_getHeight();
 
void display_clear(void);
 
/* GENERAL NOTES ON USAGE, and differences between using the 2.9inch (and MIKROE 1.54inch) vs
1.54inch (waveshare) functions:
- It is simple to do any kind of displaying with the 2.9inch eink display. Simply call the
`display_render()` function, with the arguments of your choice. E.g.
  . To display the frame buffer using full update, with a clear happening before displaying,
  call `display_render(FULL_UPDATE, WITH_CLEAR)`.
  . For partial update, without clear, call `display_render(PARTIAL_UPDATE, WITHOUT_CLEAR)`.
  That is all that is required.
- However, if using the 1.54inch display:
  . To do a full update (always preceded with a clear), simply call the function `display_render_full()`.
  . To do a partial update, call the function `display_render_partial()`, with `true` or `false` as the argument depending
    on whether you want the eink display to be put in Deep Sleep mode after the update is done.
*/
#if (defined EPAPER_2_9_INCH || defined EPAPER_MIKROE_1_54_INCH)
 
#ifdef EPAPER_MIKROE_1_54_INCH
ca_error display_initialise(void);
 
ca_error display_deinitialise(void);
#endif
 
void display_render(
#ifdef EPAPER_2_9_INCH
    SIF_IL3820_Update_Mode updt_mode,
    SIF_IL3820_Clear_Mode  clr_mode);
#elif defined EPAPER_MIKROE_1_54_INCH
    SIF_SSD1608_Update_Mode updt_mode,
    SIF_SSD1608_Clear_Mode  clr_mode);
#endif
 
#ifdef EPAPER_MIKROE_1_54_INCH
 
void display_render_nowait(SIF_SSD1608_Update_Mode updt_mode, SIF_SSD1608_Clear_Mode clr_mode);
 
#endif
 
#elif defined EPAPER_WAVESHARE_1_54_INCH
 
void display_render_full(void);
 
void display_render_partial(bool sleep_when_done);
 
#endif
 
void display_fixed_image(const uint8_t *image);
 
#ifdef EPAPER_MIKROE_1_54_INCH
 
void display_fixed_image_nowait(const uint8_t *image);
 
#endif
 
// not documented
//void display_setTextWrap(bool w);
void display_drawTriangle(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t color);
void display_fillTriangle(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t color);
void display_drawRoundRect(uint16_t x0, uint16_t y0, uint16_t w, uint16_t h, uint16_t radius, uint16_t color);
void display_fillRoundRect(uint16_t x0, uint16_t y0, uint16_t w, uint16_t h, uint16_t radius, uint16_t color);
 
void display_drawBitmapV1(uint16_t x, uint16_t y, const uint8_t *bitmap, uint16_t w, uint16_t h, uint16_t color);
void display_drawBitmapV1_bg(uint16_t       x,
                             uint16_t       y,
                             const uint8_t *bitmap,
                             uint16_t       w,
                             uint16_t       h,
                             uint16_t       color,
                             uint16_t       bg);
void display_drawBitmapV2(uint16_t x, uint16_t y, const uint8_t *bitmap, uint16_t w, uint16_t h, uint16_t color);
void display_drawBitmapV2_bg(uint16_t       x,
                             uint16_t       y,
                             const uint8_t *bitmap,
                             uint16_t       w,
                             uint16_t       h,
                             uint16_t       color,
                             uint16_t       bg);
void display_drawPixel(int16_t x, int16_t y, uint16_t color);
 
uint8_t display_getRotation();
 
void display_customChar(const uint8_t *c);
void display_drawChar(uint16_t x, uint16_t y, uint8_t c, uint16_t color, uint16_t bg, uint8_t size);
 
void display_setContrast(uint32_t contrast);
void display_slider(int x, int y, int length, int value);
void display_progressbar(int x, int y, int length, int value);
 
#ifdef __cplusplus
}
#endif
 
#endif