components/tft/tft.h

changeset 29
45647136ec95
parent 20
3fd5e0fc075f
--- a/components/tft/tft.h	Mon Oct 29 11:32:03 2018 +0100
+++ b/components/tft/tft.h	Mon Oct 29 12:16:37 2018 +0100
@@ -12,6 +12,9 @@
 #include <stdlib.h>
 #include "tftspi.h"
 
+/**
+ * @brief Window coordinates
+ */
 typedef struct {
 	uint16_t        x1;
 	uint16_t        y1;
@@ -19,6 +22,9 @@
 	uint16_t        y2;
 } dispWin_t;
 
+/**
+ * @brief Font description.
+ */
 typedef struct {
 	uint8_t 	*font;
 	uint8_t 	x_size;
@@ -56,29 +62,14 @@
 // =========================================================================================
 
 
-// Buffer is created during jpeg decode for sending data
-// Total size of the buffer is  2 * (JPG_IMAGE_LINE_BUF_SIZE * 3)
-// The size must be multiple of 256 bytes !!
-#define JPG_IMAGE_LINE_BUF_SIZE 512
-
-// --- Constants for ellipse function ---
-#define TFT_ELLIPSE_UPPER_RIGHT 0x01
-#define TFT_ELLIPSE_UPPER_LEFT  0x02
-#define TFT_ELLIPSE_LOWER_LEFT  0x04
-#define TFT_ELLIPSE_LOWER_RIGHT 0x08
-
-// Constants for Arc function
-// number representing the maximum angle (e.g. if 100, then if you pass in start=0 and end=50, you get a half circle)
-// this can be changed with setArcParams function at runtime
-#define DEFAULT_ARC_ANGLE_MAX 360
-// rotational offset in degrees defining position of value 0 (-90 will put it at the top of circle)
-// this can be changed with setAngleOffset function at runtime
+/**
+ * @brief rotational offset in degrees defining position of value 0 (-90 will put it at the top of circle)
+ *        this can be changed with setAngleOffset function at runtime
+ */
 #define DEFAULT_ANGLE_OFFSET -90
 
 #define PI 3.14159265359
 
-#define MIN_POLIGON_SIDES	3
-#define MAX_POLIGON_SIDES	60
 
 // === Color names constants ===
 extern const color_t TFT_BLACK;
@@ -101,17 +92,14 @@
 extern const color_t TFT_GREENYELLOW;
 extern const color_t TFT_PINK;
 
-// === Color invert constants ===
-#define INVERT_ON		1
-#define INVERT_OFF		0
 
 // === Special coordinates constants ===
-#define CENTER	-9003
-#define RIGHT	-9004
-#define BOTTOM	-9004
+#define CENTER	-9003			///< Center X or Y
+#define RIGHT	-9004			///< Right X
+#define BOTTOM	-9004			///< Bottom Y
 
-#define LASTX	7000
-#define LASTY	8000
+#define LASTX	7000			///< At last X position
+#define LASTY	8000			///< At last Y position
 
 // === Embedded fonts constants ===
 #define DEFAULT_FONT		0	///< 12 points 95 characters DejaVu font.

mercurial