Home - Ambercroft/TFT_eSPI GitHub Wiki

Welcome to the TFT_eSPI wiki!

This is not the main repository. Go there unless you are editing this Wiki.
Main Repository

This HOME PAGE is only for development. Normal Start here will be the normal beginning.

The directories are divided into groups:

Functions rely on the TFT_eSPI Class are titled with 'function'.

Separate classes have the required class at the top and are titled with 'CLASS'.

  • COLOUR >> See colours for acceptable formats
  • int16_t COLOURS
  • int32_t Screen dimensions

#include <TFT_eSPI.h> // Hardware-specific library #include <SPI.h>

TFT_eSPI tft = TFT_eSPI(); // Invoke custom library

Unless another class is invoked, all functions would use ( assume last line is used ) tft.function_name();

FLOW

  • Basic outline -> See Start Here
  • Hardware settings -> See Hardware
  • Select specific functions

EDITING

Any functions which are deprecated should be so marked but not removed. This should prevent the function from being added accidentally at a later date. Refer any replacement so the reader knows the the new programming structure.

Format

Function
Description
Description of passed parameters
Description of returned parameters. Assumed void unless described here.
Reference to closely coupled functions
Reference to example programs


TODO

Done Folder Activity Notes
. Home Clean up format when folders done
. Button CLASS Review missing and ??
. Colour functions table for colours
. Drawing functions Review
. Font functions Function defs not found
. Hardware setup Started, need to figure out structure
. Image functions Example links needed
. Installation Just added from existing Wiki
. Sprite CLASS All
. Start here Base layout almost complete
. Text functions conflicts, ??, 4 functions
. Touch functions All
. ALL Example links !! and ?? fixes required

SORT ME

Put functions here if uncertain the position to be placed in this WIKI.

⚠️ **GitHub.com Fallback** ⚠️