lv_conf_templ.h update

lv_conf_templ.h

@@ -11,6 +11,10 @@
 /*----------------
  * Dynamic memory
  *----------------*/
+/*
+ * Memory size which will be used by the library
+ * to store the graphical objects and other data
+ */
 #define LV_MEM_CUSTOM      0                /*1: use custom malloc/free, 0: use the built-in lv_mem_alloc/lv_mem_free*/
 #if LV_MEM_CUSTOM == 0
 #define LV_MEM_SIZE    (32U * 1024U)        /*Size memory used by mem_alloc (in bytes)*/
@@ -31,23 +35,29 @@
 #define LV_VER_RES          (240)
 #define LV_DPI              100
 
-/* Buffered rendering: >= LV_DOWNSCALE * lv_disp_hor_res() or 0 to disable buffering*/
-#define LV_VDB_SIZE         (20  * 1024)
-#define LV_VDB_ADR          0       /*Place VDB to a specific address (e.g. in external RAM) (0: allocate into RAM)*/
+/* Size of internal graphics buffer (required for buffered drawing)
+ * VDB means Virtual Display Buffer (the internal graphics buffer)
+ * Set to 0 for unbuffered drawing
+ * Set to >= LV_HOR_RES for buffered drawing if LV_ANTIALIAS = 0
+ * Set to >= 2 * LV_HOR_RES for buffered drawing if LV_ANTIALIAS = 1
+ * More info: https://littlevgl.com/basics#drawing-and-rendering*/
+#define LV_VDB_SIZE         (20 * 1024)  /*Size of VDB in pixel count*/
+#define LV_VDB_ADR          0            /*Place VDB to a specific address (e.g. in external RAM) (0: allocate automatically  into RAM)*/
 
-/* Use two Virtual Display buffers (VDB) parallelize rendering and flushing
+/* Use two Virtual Display buffers (VDB) parallelize rendering and flushing (optional)
  * The flushing should use DMA to write the frame buffer in the background*/
-#define LV_VDB_DOUBLE       0
-#define LV_VDB2_ADR         0       /*Place VDB2 to a specific address (e.g. in external RAM) (0: allocate into RAM)*/
+#define LV_VDB_DOUBLE       0       /*1: Enable the use of 2 VDBs*/
+#define LV_VDB2_ADR         0       /*Place VDB2 to a specific address (e.g. in external RAM) (0: allocate automatically into RAM)*/
 
-/* Enable anti aliasing
- * If enabled everything will be rendered in double size and filtered to normal size */
-#define LV_ANTIALIAS        1
+/* Enable anti-aliasing
+ * If enabled everything will be rendered in double size and filtered to normal size.
+ * Fonts and Images will be downscaled */
+#define LV_ANTIALIAS        1       /*1: Enable anti-aliasing*/
 
-/* Enable anti aliasing only for fonts (texts)
- * It half the size of the letters so you should use double sized fonts
- * Much faster then normal anti aliasing  */
-#define LV_FONT_ANTIALIAS   0
+/* Enable anti-aliasing only for fonts (texts)
+ * It downscales the fonts to half size so you should use double sized fonts
+ * Much faster then normal anti-aliasing  */
+#define LV_FONT_ANTIALIAS   0       /*1: Enable font anti-aliasing*/
 
 /*Screen refresh settings*/
 #define LV_REFR_PERIOD      50    /*Screen refresh period in milliseconds*/
@@ -66,19 +76,19 @@
 #define LV_INDEV_LONG_PRESS_REP_TIME    100                    /*Repeated trigger period in long press [ms] */
 
 /*Color settings*/
-#define LV_COLOR_DEPTH     16
+#define LV_COLOR_DEPTH     16                     /*Color depth: 1/8/16/24*/
 #define LV_COLOR_TRANSP    LV_COLOR_LIME          /*Images pixels with this color will not be drawn (chroma keying)*/
 
 /*Text settings*/
-#define LV_TXT_UTF8             1
+#define LV_TXT_UTF8             1                /*Enable UTF-8 coded Unicode character usage */
 #define LV_TXT_BREAK_CHARS     " ,.;:-_"         /*Can break texts on these chars*/
 
 /*Graphics feature usage*/
-#define USE_LV_ANIMATION        1               /*1: disable all animations*/
-#define USE_LV_SHADOW           1               /*1: disable shadows*/
+#define USE_LV_ANIMATION        1               /*1: Enable all animations*/
+#define USE_LV_SHADOW           1               /*1: Enable shadows*/
 #define USE_LV_GROUP            1               /*1: Enable object groups (for keyboards)*/
 #define USE_LV_GPU              1               /*1: Enable GPU interface*/
-#define USE_LV_FILESYSTEM       1               /*1: Enable file system (required by images aka. lv_img)*/
+#define USE_LV_FILESYSTEM       1               /*1: Enable file system (required by images*/
 
 /*================
  *  THEME USAGE
@@ -94,6 +104,7 @@
 /*==================
  *    FONT USAGE
  *===================*/
+/*More info about fonts: https://littlevgl.com/basics#fonts*/
 #define LV_FONT_DEFAULT        &lv_font_dejavu_40     /*Always set a default font from the built-in fonts*/
 
 #define USE_LV_FONT_DEJAVU_10              0
@@ -159,6 +170,9 @@
 /*==================
  *  LV OBJ X USAGE 
  *================*/
+/*
+ * Documentation of the object types: https://littlevgl.com/object-types
+ */
 
 /*****************
  * Simple object
@@ -170,7 +184,7 @@
 #define LV_LABEL_SCROLL_SPEED       25     /*Hor, or ver. scroll speed (px/sec) in 'LV_LABEL_LONG_SCROLL/ROLL' mode*/
 #endif
 
-/*Image (dependencies: lv_label (if symbols are enabled) from misc: FSINT, UFS)*/
+/*Image (dependencies: lv_label*/
 #define USE_LV_IMG      1
 
 /*Line (dependencies: -*/