simplegfx.h

Go to the documentation of this file.

/*
 * @file simplegfx.h
 *
 * @author Matthew Matz
 *
 * @version 0.5
 *
 * @copyright Copyright (C) Parallax, Inc. 2019.  See end of file for
 * terms of use (MIT License).
 *
 * @brief This is a driver that allows the Propeller Multicore Microcontroller to 
 * draw text, shapes, and bitmap files on various screens and displays.
 *
 * @detail This helper-library allows the Propeller Multicore Microcontroller to 
 * draw pixels, lines, circles, recatngles, rounded rectagles, triangles, formatted text 
 * in multiple fonts, bitmap images stored on an SD card on various screens and displays. 
 * At Parallax, we would like to thank Adafruit Industries as parts of this library 
 * were dervied from the Adafruit GFX library for Arduino.  Please submit bug reports, 
 * suggestions, and improvements to this code to editor@parallax.com.
 * 
 * @note If fonts are installed, they occupy EEPROM addresses 40576 to 63359.
 */

#ifndef _SCREEN_GFX_
#define _SCREEN_GFX_

#if defined(__cplusplus)      // If compiling for C++
extern "C" {                  // Compile for C
#endif


#include "simpletools.h"


// Font size and face
#ifndef SMALL
  #define SMALL   1
#endif

#ifndef MEDIUM
  #define MEDIUM  2
#endif

#ifndef LARGE
  #define LARGE   3
#endif


#ifndef FONT_SANS
  #define FONT_SANS       0
#endif

#ifndef FONT_SERIF
  #define FONT_SERIF      1
#endif

#ifndef FONT_SCRIPT
  #define FONT_SCRIPT     2
#endif

#ifndef FONT_BUBBLE
  #define FONT_BUBBLE     3
#endif


#ifndef INTF_SPI_NO_BUFFER
  #define INTF_SPI_NO_BUFFER       0b00
#endif

#ifndef INTF_SPI_WITH_BUFFER
  #define INTF_SPI_WITH_BUFFER     0b10
#endif

#ifndef INTF_I2C_NO_BUFFER
  #define INTF_I2C_NO_BUFFER       0b01
#endif

#ifndef INTF_I2C_WITH_BUFFER
  #define INTF_I2C_WITH_BUFFER     0b11
#endif


#ifndef gfx_swap
  #define gfx_swap(a, b)  (((a) ^= (b)), ((b) ^= (a)), ((a) ^= (b)))    // No-temp-var swap operation
#endif

#ifndef absv
  #define absv(x) ((x)<0 ? -(x) : (x))
#endif


// Radix Constants
#ifndef HEX
  #define HEX    -16
#endif

#ifndef OCT
  #define OCT    -8
#endif

#ifndef BIN
  #define BIN    -2
#endif

#ifndef DEC
  #define DEC    -10
#endif



typedef struct screen_st {
  int                           width;

  int                           height;

  int                           rotation;

  int                           cursor_x;

  int                           cursor_y;

  int                           font[5];

  char                          color_depth;

  char                          text_size;

  char                          text_wrap;

  int                           text_color;

  int                           bg_color;

  int                           display_mode;

    
  i2c*                          eepromBus;

  
  i2c*                          deviceBus;

  char                          deviceInterface;


  unsigned char                 dev_id;

  char                          status_pin;

  char                          sdi_pin;

  char                          rst_pin;

  char                          clk_pin;

  char                          dc_pin;


  int                           image_size;

  char*                         image_ptr;


  char*                         customCharSmall;

  char*                         customCharMed;

  char*                         customCharLarge;

    
  char (*deviceWriteLock)       (void);

  void (*deviceWriteLockSet)    (struct screen_st*);

  void (*deviceWriteLockClear)  (struct screen_st*);


  void (*deviceDrawPixel)       (struct screen_st*, int  x, int y, int color);

  int  (*deviceGetPixel)        (struct screen_st*, int  x, int y);

  void (*deviceDrawLine)        (struct screen_st*, int  x, int y, int w, int h, int color);

  void (*deviceDrawFastHLine)   (struct screen_st*, int  x, int y, int w, int color);

  void (*deviceDrawFastVLine)   (struct screen_st*, int  x, int y, int w, int color);

  void (*deviceFillRect)        (struct screen_st*, int  x, int y, int w, int h, int color);

  void (*deviceCopyRect)        (struct screen_st*, int  x, int y, int x0, int y0, int x1, int y1);


  void (*deviceClearDisplay)    (struct screen_st*);

  void (*deviceUpdateDisplay)   (struct screen_st*);

  void (*deviceResetDisplay)    (struct screen_st*);

  void (*deviceInvertDisplay)   (struct screen_st*, char i);

  void (*deviceSleepWakeDisplay)(struct screen_st*, char i);

  void (*deviceScrollDisplay)   (struct screen_st*, int  h, int v);

} screen_t;

typedef screen_t screen;






void clearDisplay(screen_t *dev);

void updateDisplay(screen_t *dev);

void resetDisplay(screen_t *dev);

void drawPixel(screen_t *dev, int x, int y, int color);

void drawFastHLine(screen_t *dev, int x, int y, int w, int color);

void drawFastVLine(screen_t *dev, int x, int y, int h, int color);

void drawLine(screen_t *dev, int x0, int y0, int x1, int y1, int color);

void drawCircle(screen_t *dev, int x0, int y0, int r, int color);

void drawCircleHelper(screen_t *dev, int x0, int y0, int r, char cornername, int color);

void fillCircle(screen_t *dev, int x0, int y0, int r, int color);

void fillCircleHelper(screen_t *dev, int x0, int y0, int r, char cornername, int delta, int color);

void drawRect(screen_t *dev, int x, int y, int w, int h, int color);

void fillRect(screen_t *dev, int x, int y, int w, int h, int color);

void drawRoundRect(screen_t *dev, int x, int y, int w, int h, int r, int color);

void fillRoundRect(screen_t *dev, int x, int y, int w, int h, int r, int color);

void drawTriangle(screen_t *dev, int x0, int y0, int x1, int y1, int x2, int y2, int color);

void fillTriangle(screen_t *dev, int x0, int y0, int x1, int y1, int x2, int y2, int color);

void drawCopy(screen_t *dev, int x, int y, int w, int h, int x1, int y1);

void setTextSize(screen_t *dev, char s);

void setTextFont(screen_t *dev, char f);

void setTextColor(screen_t *dev, int color);

void setBgColor(screen_t *dev, int color);

void setTextWrap(screen_t *dev, char w);

void setCursor(screen_t *dev, int x, int y, char size);

int  drawPrint(screen_t *dev, const char *fmt, ...);

void drawNumber(screen_t *dev, float d, int r);

void drawText(screen_t *dev, char *myString);

void drawChar(screen_t *dev, char c);

int  getCursorX(screen_t *dev);

int  getCursorY(screen_t *dev);

void setDisplayRotation(screen_t *dev, char r);

char getDisplayRotation(screen_t *dev);

int  getDisplayWidth(screen_t *dev);

int  getDisplayHeight(screen_t *dev);

void loadFonts(screen_t *dev, i2c *eeBus);

void drawCharSmall(screen_t *dev, unsigned char c);

void drawCharMedium(screen_t *dev, unsigned char c);

void drawCharLarge(screen_t *dev, unsigned char c);

void invertDisplay(screen_t *dev, char i);                           

void sleepWakeDisplay(screen_t *dev, char i);

void scrollDisplay(screen_t *dev, int  h, int v);

char isInverted(screen_t *dev);

char isAsleep(screen_t *dev);

unsigned char  getScrollVertical(screen_t *dev);

unsigned char  getScrollHorizontal(screen_t *dev);

void drawBitmap(screen_t *dev, char *imgdir, int x, int y);

  
#if defined(__cplusplus)
}     // End compile for C block
#endif
/* __cplusplus */


#endif // _SCREEN_GFX_


/*
 * Because this library is bsed in part on the Adafruit GFX library, this 
 * notice must be included with this distribution:
 * --------------------------------------------------------------------------
 * This is the core graphics library for all our displays, providing a common
 * set of graphics primitives (points, lines, circles, etc.).  It needs to be
 * paired with a hardware-specific library for each display device we carry
 * (to handle the lower-level functions).
 * 
 * Adafruit invests time and resources providing this open source code, please
 * support Adafruit & open-source hardware by purchasing products from Adafruit!
 * 
 * Copyright (c) 2013 Adafruit Industries.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------
 */