GUIslice_drv_tft_espi.h

Go to the documentation of this file.

#ifndef _GUISLICE_DRV_TFT_ESPI_H_
#define _GUISLICE_DRV_TFT_ESPI_H_

// =======================================================================
// GUIslice library (driver layer for bodmer/TFT_eSPI)
// - Calvin Hass
// - https://www.impulseadventure.com/elec/guislice-gui.html
// - https://github.com/ImpulseAdventure/GUIslice
// =======================================================================
//
// The MIT License
//
// Copyright 2016-2020 Calvin Hass
//
// 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.
//
// =======================================================================


// =======================================================================
// Driver Layer for bodmer/TFT_eSPI
// - https://github.com/Bodmer/TFT_eSPI
// =======================================================================

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

#include "GUIslice.h"

#include <stdio.h>


// Determine characteristics for configured touch driver
// - DRV_TOUCH_TYPE_EXTERNAL: TDrv* external touch APIs are enabled
// - DRV_TOUCH_TYPE_RES:      Resistive overlay
// - DRV_TOUCH_TYPE_CAP:      Capacitive overlay
// - DRV_TOUCH_TYPE_ANALOG:   Analog input
#if defined(DRV_TOUCH_ADA_STMPE610)
  #define DRV_TOUCH_TYPE_EXTERNAL
  #define DRV_TOUCH_TYPE_RES         // Resistive
#elif defined(DRV_TOUCH_ADA_FT6206)
  #define DRV_TOUCH_TYPE_EXTERNAL
  #define DRV_TOUCH_TYPE_CAP         // Capacitive
#elif defined(DRV_TOUCH_ADA_SIMPLE)
  #define DRV_TOUCH_TYPE_EXTERNAL
  #define DRV_TOUCH_TYPE_RES         // Resistive
  #define DRV_TOUCH_TYPE_ANALOG      // Analog
#elif defined(DRV_TOUCH_XPT2046_STM)
  #define DRV_TOUCH_TYPE_EXTERNAL
  #define DRV_TOUCH_TYPE_RES         // Resistive
#elif defined(DRV_TOUCH_XPT2046_PS)
  #define DRV_TOUCH_TYPE_EXTERNAL
  #define DRV_TOUCH_TYPE_RES         // Resistive
#elif defined(DRV_TOUCH_TFT_ESPI)
  #define DRV_TOUCH_TYPE_RES         // Resistive
#elif defined(DRV_TOUCH_INPUT)
  #define DRV_TOUCH_TYPE_EXTERNAL
#elif defined(DRV_TOUCH_HANDLER)
  #define DRV_TOUCH_TYPE_EXTERNAL
#elif defined(DRV_TOUCH_NONE)
#endif // DRV_TOUCH_*

// Determine if calibration required
// - Enable for resistive displays
// - User config can also enable for capacitive displays by adding:
//   #define DRV_TOUCH_CALIB
#if defined(DRV_TOUCH_TYPE_RES)
  #define DRV_TOUCH_CALIB
#endif

#if defined(DRV_TOUCH_CALIB)
  // Ensure calibration settings are present in the config file
  #if !defined(ADATOUCH_X_MIN)
    // We didn't locate the calibration settings, so provide some
    // temporary defaults. This typically only occurs if user has
    // decided to force calibration on a capacitive display by
    // adding DRV_TOUCH_CALIB, but hasn't yet added the calibration
    // settings (ADATOUCH_X/Y_MIN/MAX) from the calibration sketch yet.
    #warning Calibration settings (ADATOUCH_X/Y_MIN/MAX) need to be added to config. Using defaults.
    #define ADATOUCH_X_MIN 0
    #define ADATOUCH_X_MAX 4000
    #define ADATOUCH_Y_MIN 0
    #define ADATOUCH_Y_MAX 4000
    #define ADATOUCH_REMAP_YX 0
  #endif // ADATOUCH_X_MIN
#endif // DRV_TOUCH_CALIB

// Additional defines
// - Provide default if not in config file
#if !defined(GSLC_SPIFFS_EN)
  #define GSLC_SPIFFS_EN 0
#endif // GSLC_SPIFFS_EN


// =======================================================================
// API support definitions
// - These defines indicate whether the driver includes optimized
//   support for various APIs. If a define is set to 0, then the
//   GUIslice core emulation will be used instead.
// - At the very minimum, the point draw routine must be available:
//   gslc_DrvDrawPoint()
// =======================================================================

#define DRV_HAS_DRAW_POINT             1 

#define DRV_HAS_DRAW_POINTS            0 
#define DRV_HAS_DRAW_LINE              1 
#define DRV_HAS_DRAW_RECT_FRAME        1 
#define DRV_HAS_DRAW_RECT_FILL         1 
#define DRV_HAS_DRAW_RECT_ROUND_FRAME  1 
#define DRV_HAS_DRAW_RECT_ROUND_FILL   1 
#define DRV_HAS_DRAW_CIRCLE_FRAME      1 
#define DRV_HAS_DRAW_CIRCLE_FILL       1 
#define DRV_HAS_DRAW_TRI_FRAME         1 
#define DRV_HAS_DRAW_TRI_FILL          1 
#define DRV_HAS_DRAW_TEXT              1 
#define DRV_HAS_DRAW_BMP_MEM           0 

#define DRV_OVERRIDE_TXT_ALIGN         1 

// =======================================================================
// Driver-specific members
// =======================================================================
typedef struct {
  gslc_tsColor  nColBkgnd;      

  gslc_tsRect   rClipRect;      

} gslc_tsDriver;



// =======================================================================
// Public APIs to GUIslice core library
// - These functions define the renderer / driver-dependent
//   implementations for the core drawing operations within
//   GUIslice.
// =======================================================================


// -----------------------------------------------------------------------
// Configuration Functions
// -----------------------------------------------------------------------

bool gslc_DrvInit(gslc_tsGui* pGui);


bool gslc_DrvInitTs(gslc_tsGui* pGui,const char* acDev);


void gslc_DrvDestruct(gslc_tsGui* pGui);


const char* gslc_DrvGetNameDisp(gslc_tsGui* pGui);


const char* gslc_DrvGetNameTouch(gslc_tsGui* pGui);

void* gslc_DrvGetDriverDisp(gslc_tsGui* pGui);

void* gslc_DrvGetDriverTouch(gslc_tsGui* pGui);

// -----------------------------------------------------------------------
// Image/surface handling Functions
// -----------------------------------------------------------------------


void* gslc_DrvLoadImage(gslc_tsGui* pGui,gslc_tsImgRef sImgRef);


bool gslc_DrvSetBkgndImage(gslc_tsGui* pGui,gslc_tsImgRef sImgRef);

bool gslc_DrvSetBkgndColor(gslc_tsGui* pGui,gslc_tsColor nCol);

bool gslc_DrvSetElemImageNorm(gslc_tsGui* pGui,gslc_tsElem* pElem,gslc_tsImgRef sImgRef);

bool gslc_DrvSetElemImageGlow(gslc_tsGui* pGui,gslc_tsElem* pElem,gslc_tsImgRef sImgRef);


void gslc_DrvImageDestruct(void* pvImg);


bool gslc_DrvSetClipRect(gslc_tsGui* pGui,gslc_tsRect* pRect);


// -----------------------------------------------------------------------
// Font handling Functions
// -----------------------------------------------------------------------

const void* gslc_DrvFontAdd(gslc_teFontRefType eFontRefType,const void* pvFontRef,uint16_t nFontSz);

void gslc_DrvFontsDestruct(gslc_tsGui* pGui);


bool gslc_DrvGetTxtSize(gslc_tsGui* pGui,gslc_tsFont* pFont,const char* pStr,gslc_teTxtFlags eTxtFlags,
        int16_t* pnTxtX,int16_t* pnTxtY,uint16_t* pnTxtSzW,uint16_t* pnTxtSzH);


bool gslc_DrvDrawTxt(gslc_tsGui* pGui,int16_t nTxtX,int16_t nTxtY,gslc_tsFont* pFont,const char* pStr,gslc_teTxtFlags eTxtFlags,gslc_tsColor colTxt,gslc_tsColor colBg);

//⁠
bool gslc_DrvDrawTxtAlign(gslc_tsGui* pGui,int16_t nX0,int16_t nY0,int16_t nX1,int16_t nY1,int8_t eTxtAlign,
        gslc_tsFont* pFont,const char* pStr,gslc_teTxtFlags eTxtFlags,gslc_tsColor colTxt,gslc_tsColor colBg);

// -----------------------------------------------------------------------
// Screen Management Functions
// -----------------------------------------------------------------------

void gslc_DrvPageFlipNow(gslc_tsGui* pGui);


// -----------------------------------------------------------------------
// Graphics Primitives Functions
// -----------------------------------------------------------------------

bool gslc_DrvDrawPoint(gslc_tsGui* pGui,int16_t nX,int16_t nY,gslc_tsColor nCol);

bool gslc_DrvDrawPoints(gslc_tsGui* pGui,gslc_tsPt* asPt,uint16_t nNumPt,gslc_tsColor nCol);

bool gslc_DrvDrawFrameRect(gslc_tsGui* pGui,gslc_tsRect rRect,gslc_tsColor nCol);


bool gslc_DrvDrawFillRect(gslc_tsGui* pGui,gslc_tsRect rRect,gslc_tsColor nCol);


bool gslc_DrvDrawFrameRoundRect(gslc_tsGui* pGui,gslc_tsRect rRect,int16_t nRadius,gslc_tsColor nCol);


bool gslc_DrvDrawFillRoundRect(gslc_tsGui* pGui,gslc_tsRect rRect,int16_t nRadius,gslc_tsColor nCol);



bool gslc_DrvDrawLine(gslc_tsGui* pGui,int16_t nX0,int16_t nY0,int16_t nX1,int16_t nY1,gslc_tsColor nCol);


bool gslc_DrvDrawFrameCircle(gslc_tsGui* pGui,int16_t nMidX,int16_t nMidY,uint16_t nRadius,gslc_tsColor nCol);


bool gslc_DrvDrawFillCircle(gslc_tsGui* pGui,int16_t nMidX,int16_t nMidY,uint16_t nRadius,gslc_tsColor nCol);


bool gslc_DrvDrawFrameTriangle(gslc_tsGui* pGui,int16_t nX0,int16_t nY0,
        int16_t nX1,int16_t nY1,int16_t nX2,int16_t nY2,gslc_tsColor nCol);


bool gslc_DrvDrawFillTriangle(gslc_tsGui* pGui,int16_t nX0,int16_t nY0,
        int16_t nX1,int16_t nY1,int16_t nX2,int16_t nY2,gslc_tsColor nCol);


bool gslc_DrvDrawImage(gslc_tsGui* pGui,int16_t nDstX,int16_t nDstY,gslc_tsImgRef sImgRef);


void gslc_DrvDrawMonoFromMem(gslc_tsGui* pGui,int16_t nDstX, int16_t nDstY, const unsigned char *pBitmap,bool bProgMem);


void gslc_DrvDrawBmp24FromMem(gslc_tsGui* pGui,int16_t nDstX, int16_t nDstY,const unsigned char* pBitmap,bool bProgMem);

#if (GSLC_SPIFFS_EN)
bool gslc_DrvDrawBmpFromFile(gslc_tsGui* pGui,int16_t nDstX,int16_t nDstY,gslc_tsImgRef sImgRef);


bool gslc_DrvDrawJpegFromFile(gslc_tsGui* pGui,int16_t nDstX,int16_t nDstY,gslc_tsImgRef sImgRef);

#endif // end GSLC_SPIFFS_EN

void gslc_DrvDrawBkgnd(gslc_tsGui* pGui);


// -----------------------------------------------------------------------
// Touch Functions (if using display driver library)
// -----------------------------------------------------------------------

#if defined(DRV_TOUCH_IN_DISP)
// Use TFT_eSPI's integrated XPT2046 touch driver

bool gslc_DrvInitTouch(gslc_tsGui* pGui,const char* acDev);


bool gslc_DrvGetTouch(gslc_tsGui* pGui,int16_t* pnX,int16_t* pnY,uint16_t* pnPress,gslc_teInputRawEvent* peInputEvent,int16_t* pnInputVal);

#endif // DRV_TOUCH_IN_DISP


// -----------------------------------------------------------------------
// Touch Functions (if using external touch driver library)
// -----------------------------------------------------------------------

// Check for deprecated config option
// - This check will be removed in future releases
#if defined(DRV_TOUCH_XPT2046)
  #error "NOTE: DRV_TOUCH_XPT2046 has been renamed to DRV_TOUCH_XPT2046_STM. Please update your config."
#endif

#if defined(DRV_TOUCH_TYPE_EXTERNAL)

bool gslc_TDrvInitTouch(gslc_tsGui* pGui,const char* acDev);


bool gslc_TDrvGetTouch(gslc_tsGui* pGui, int16_t* pnX, int16_t* pnY, uint16_t* pnPress, gslc_teInputRawEvent* peInputEvent, int16_t* pnInputVal);

#endif // DRV_TOUCH_*


// -----------------------------------------------------------------------
// Dynamic Screen rotation and Touch axes swap/flip functions
// -----------------------------------------------------------------------

bool gslc_DrvRotate(gslc_tsGui* pGui, uint8_t nRotation);


// =======================================================================
// Private Functions
// - These functions are not included in the scope of APIs used by
//   the core GUIslice library. Instead, these functions are used
//   to support the operations within this driver layer.
// =======================================================================

uint16_t gslc_DrvAdaptColorToRaw(gslc_tsColor nCol);

#ifdef __cplusplus
}
#endif // __cplusplus
#endif // _GUISLICE_DRV_TFT_ESPI_H_