Make gfxconf.example.h all comments of the default.

1 files changed, 172 insertions, 167 deletions

diff --git a/gfxconf.example.h b/gfxconf.example.h
index 713364f4..652b6a1b 100644
--- a/gfxconf.example.h
+++ b/gfxconf.example.h
@@ -9,8 +9,12 @@
 /**
  * Copy this file into your project directory and rename it as gfxconf.h
  * Edit your copy to turn on the uGFX features you want to use.
- * The values below are the defaults. You should delete anything
- * you are leaving as default.
+ * The values below are the defaults.
+ *
+ * Only remove the comments from lines where you want to change the
+ * default value. This allows definitions to be included from
+ * driver makefiles when required and provides the best future
+ * compatibility for your project.
  *
  * Please use spaces instead of tabs in this file.
  */
@@ -24,7 +28,7 @@
 ///////////////////////////////////////////////////////////////////////////
 //#define GFX_USE_OS_CHIBIOS                           FALSE
 //#define GFX_USE_OS_FREERTOS                          FALSE
-    #define GFX_FREERTOS_USE_TRACE                   FALSE
+//    #define GFX_FREERTOS_USE_TRACE                   FALSE
 //#define GFX_USE_OS_WIN32                             FALSE
 //#define GFX_USE_OS_LINUX                             FALSE
 //#define GFX_USE_OS_OSX                               FALSE
@@ -33,220 +37,221 @@
 ///////////////////////////////////////////////////////////////////////////
 // GDISP                                                                 //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GDISP                                FALSE
-
-#define GDISP_NEED_AUTOFLUSH                         FALSE
-#define GDISP_NEED_TIMERFLUSH                        FALSE
-#define GDISP_NEED_VALIDATION                        TRUE
-#define GDISP_NEED_CLIP                              TRUE
-#define GDISP_NEED_CIRCLE                            FALSE
-#define GDISP_NEED_ELLIPSE                           FALSE
-#define GDISP_NEED_ARC                               FALSE
-#define GDISP_NEED_CONVEX_POLYGON                    FALSE
-#define GDISP_NEED_SCROLL                            FALSE
-#define GDISP_NEED_PIXELREAD                         FALSE
-#define GDISP_NEED_CONTROL                           FALSE
-#define GDISP_NEED_QUERY                             FALSE
-#define GDISP_NEED_MULTITHREAD                       FALSE
-#define GDISP_NEED_STREAMING                         FALSE
-#define GDISP_NEED_TEXT                              FALSE
-    #define GDISP_NEED_ANTIALIAS                     FALSE
-    #define GDISP_NEED_UTF8                          FALSE
-    #define GDISP_NEED_TEXT_KERNING                  FALSE
-    #define GDISP_INCLUDE_FONT_UI1                   FALSE
-    #define GDISP_INCLUDE_FONT_UI2                   FALSE
-    #define GDISP_INCLUDE_FONT_LARGENUMBERS          FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS10          FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS12          FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS16          FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS24          FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS32          FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANSBOLD12      FALSE
-    #define GDISP_INCLUDE_FONT_FIXED_10X20           FALSE
-    #define GDISP_INCLUDE_FONT_FIXED_7X14            FALSE
-    #define GDISP_INCLUDE_FONT_FIXED_5X8             FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS12_AA       FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS16_AA       FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS24_AA       FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANS32_AA       FALSE
-    #define GDISP_INCLUDE_FONT_DEJAVUSANSBOLD12_AA   FALSE
-    #define GDISP_INCLUDE_USER_FONTS                 FALSE
-
-#define GDISP_NEED_IMAGE                             FALSE
-    #define GDISP_NEED_IMAGE_NATIVE                  FALSE
-    #define GDISP_NEED_IMAGE_GIF                     FALSE
-    #define GDISP_NEED_IMAGE_BMP                     FALSE
-        #define GDISP_NEED_IMAGE_BMP_1               FALSE
-        #define GDISP_NEED_IMAGE_BMP_4               FALSE
-        #define GDISP_NEED_IMAGE_BMP_4_RLE           FALSE
-        #define GDISP_NEED_IMAGE_BMP_8               FALSE
-        #define GDISP_NEED_IMAGE_BMP_8_RLE           FALSE
-        #define GDISP_NEED_IMAGE_BMP_16              FALSE
-        #define GDISP_NEED_IMAGE_BMP_24              FALSE
-        #define GDISP_NEED_IMAGE_BMP_32              FALSE
-    #define GDISP_NEED_IMAGE_JPG                     FALSE
-    #define GDISP_NEED_IMAGE_PNG                     FALSE
-    #define GDISP_NEED_IMAGE_ACCOUNTING              FALSE
-
-#define GDISP_NEED_STARTUP_LOGO                      TRUE
-
-#define GDISP_DEFAULT_ORIENTATION                    GDISP_ROTATE_LANDSCAPE
-#define GDISP_LINEBUF_SIZE                           128
-
-#define GDISP_TOTAL_DISPLAYS                         1
-    #if GDISP_TOTAL_DISPLAYS > 1
-        #define GDISP_HARDWARE_STREAM_WRITE          FALSE
-        #define GDISP_HARDWARE_STREAM_READ           FALSE
-        #define GDISP_HARDWARE_STREAM_POS            FALSE
-        #define GDISP_HARDWARE_DRAWPIXEL             FALSE
-        #define GDISP_HARDWARE_CLEARS                FALSE
-        #define GDISP_HARDWARE_FILLS                 FALSE
-        #define GDISP_HARDWARE_BITFILLS              FALSE
-        #define GDISP_HARDWARE_SCROLL                FALSE
-        #define GDISP_HARDWARE_PIXELREAD             FALSE
-        #define GDISP_HARDWARE_CONTROL               FALSE
-        #define GDISP_HARDWARE_QUERY                 FALSE
-        #define GDISP_HARDWARE_CLIP                  FALSE
-    #endif
-
-#define GDISP_TOTAL_CONTROLLERS                      1
-    #if GDISP_TOTAL_CONTROLLERS > 1
-        #define GDISP_CONTROLLER_LIST                GDISPVMT_Win32, GDISPVMT_Win32
-        #define GDISP_CONTROLLER_DISPLAYS            1, 1
-        #define GDISP_PIXELFORMAT                    GDISP_PIXELFORMAT_RGB888
-    #endif
-
-#define GDISP_USE_GFXNET                             FALSE
-    #define GDISP_GFXNET_PORT                        13001
-    #define GDISP_GFXNET_CUSTOM_LWIP_STARTUP         FALSE
-    #define GDISP_DONT_WAIT_FOR_NET_DISPLAY          FALSE
-    #define GDISP_GFXNET_UNSAFE_SOCKETS              FALSE
+//#define GFX_USE_GDISP                                FALSE
+
+//#define GDISP_NEED_AUTOFLUSH                         FALSE
+//#define GDISP_NEED_TIMERFLUSH                        FALSE
+//#define GDISP_NEED_VALIDATION                        TRUE
+//#define GDISP_NEED_CLIP                              TRUE
+//#define GDISP_NEED_CIRCLE                            FALSE
+//#define GDISP_NEED_ELLIPSE                           FALSE
+//#define GDISP_NEED_ARC                               FALSE
+//#define GDISP_NEED_CONVEX_POLYGON                    FALSE
+//#define GDISP_NEED_SCROLL                            FALSE
+//#define GDISP_NEED_PIXELREAD                         FALSE
+//#define GDISP_NEED_CONTROL                           FALSE
+//#define GDISP_NEED_QUERY                             FALSE
+//#define GDISP_NEED_MULTITHREAD                       FALSE
+//#define GDISP_NEED_STREAMING                         FALSE
+//#define GDISP_NEED_TEXT                              FALSE
+//    #define GDISP_NEED_ANTIALIAS                     FALSE
+//    #define GDISP_NEED_UTF8                          FALSE
+//    #define GDISP_NEED_TEXT_KERNING                  FALSE
+//    #define GDISP_INCLUDE_FONT_UI1                   FALSE
+//    #define GDISP_INCLUDE_FONT_UI2                   FALSE		// The smallest preferred font.
+//    #define GDISP_INCLUDE_FONT_LARGENUMBERS          FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS10          FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS12          FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS16          FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS24          FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS32          FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANSBOLD12      FALSE
+//    #define GDISP_INCLUDE_FONT_FIXED_10X20           FALSE
+//    #define GDISP_INCLUDE_FONT_FIXED_7X14            FALSE
+//    #define GDISP_INCLUDE_FONT_FIXED_5X8             FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS12_AA       FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS16_AA       FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS24_AA       FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANS32_AA       FALSE
+//    #define GDISP_INCLUDE_FONT_DEJAVUSANSBOLD12_AA   FALSE
+//    #define GDISP_INCLUDE_USER_FONTS                 FALSE
+
+//#define GDISP_NEED_IMAGE                             FALSE
+//    #define GDISP_NEED_IMAGE_NATIVE                  FALSE
+//    #define GDISP_NEED_IMAGE_GIF                     FALSE
+//    #define GDISP_NEED_IMAGE_BMP                     FALSE
+//        #define GDISP_NEED_IMAGE_BMP_1               FALSE
+//        #define GDISP_NEED_IMAGE_BMP_4               FALSE
+//        #define GDISP_NEED_IMAGE_BMP_4_RLE           FALSE
+//        #define GDISP_NEED_IMAGE_BMP_8               FALSE
+//        #define GDISP_NEED_IMAGE_BMP_8_RLE           FALSE
+//        #define GDISP_NEED_IMAGE_BMP_16              FALSE
+//        #define GDISP_NEED_IMAGE_BMP_24              FALSE
+//        #define GDISP_NEED_IMAGE_BMP_32              FALSE
+//    #define GDISP_NEED_IMAGE_JPG                     FALSE
+//    #define GDISP_NEED_IMAGE_PNG                     FALSE
+//    #define GDISP_NEED_IMAGE_ACCOUNTING              FALSE
+
+//#define GDISP_NEED_STARTUP_LOGO                      TRUE
+
+//#define GDISP_DEFAULT_ORIENTATION                    GDISP_ROTATE_LANDSCAPE    // If not defined the native hardware orientation is used.
+//#define GDISP_LINEBUF_SIZE                           128
+
+//#define GDISP_TOTAL_DISPLAYS                         1
+//    #if GDISP_TOTAL_DISPLAYS > 1
+//        // For code and speed optimization define as TRUE or FALSE if all displays have the same capability
+//        #define GDISP_HARDWARE_STREAM_WRITE          FALSE
+//        #define GDISP_HARDWARE_STREAM_READ           FALSE
+//        #define GDISP_HARDWARE_STREAM_POS            FALSE
+//        #define GDISP_HARDWARE_DRAWPIXEL             FALSE
+//        #define GDISP_HARDWARE_CLEARS                FALSE
+//        #define GDISP_HARDWARE_FILLS                 FALSE
+//        #define GDISP_HARDWARE_BITFILLS              FALSE
+//        #define GDISP_HARDWARE_SCROLL                FALSE
+//        #define GDISP_HARDWARE_PIXELREAD             FALSE
+//        #define GDISP_HARDWARE_CONTROL               FALSE
+//        #define GDISP_HARDWARE_QUERY                 FALSE
+//        #define GDISP_HARDWARE_CLIP                  FALSE
+//    #endif
+
+//#define GDISP_TOTAL_CONTROLLERS                      1
+//    #if GDISP_TOTAL_CONTROLLERS > 1
+//        #define GDISP_CONTROLLER_LIST                GDISPVMT_Win32, GDISPVMT_Win32
+//        #define GDISP_CONTROLLER_DISPLAYS            1, 1
+//        #define GDISP_PIXELFORMAT                    GDISP_PIXELFORMAT_RGB888
+//    #endif
+
+//#define GDISP_USE_GFXNET                             FALSE
+//    #define GDISP_GFXNET_PORT                        13001
+//    #define GDISP_GFXNET_CUSTOM_LWIP_STARTUP         FALSE
+//    #define GDISP_DONT_WAIT_FOR_NET_DISPLAY          FALSE
+//    #define GDISP_GFXNET_UNSAFE_SOCKETS              FALSE
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GWIN                                                                  //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GWIN                                 FALSE
-
-#define GWIN_NEED_WINDOWMANAGER                      FALSE
-
-#define GWIN_NEED_CONSOLE                            FALSE
-    #define GWIN_CONSOLE_USE_HISTORY                 FALSE
-        #define GWIN_CONSOLE_HISTORY_AVERAGING       FALSE
-        #define GWIN_CONSOLE_HISTORY_ATCREATE        FALSE
-    #define GWIN_CONSOLE_ESCSEQ                      FALSE
-	#define GWIN_CONSOLE_USE_BASESTREAM              FALSE
-    #define GWIN_CONSOLE_USE_FLOAT                   FALSE
-#define GWIN_NEED_GRAPH                              FALSE
-
-#define GWIN_NEED_WIDGET                             FALSE
-    #define GWIN_NEED_LABEL                          FALSE
-        #define GWIN_LABEL_ATTRIBUTE                 FALSE
-    #define GWIN_NEED_BUTTON                         FALSE
-        #define GWIN_BUTTON_LAZY_RELEASE             FALSE
-    #define GWIN_NEED_SLIDER                         FALSE
-    #define GWIN_NEED_CHECKBOX                       FALSE
-    #define GWIN_NEED_IMAGE                          FALSE
-        #define GWIN_NEED_IMAGE_ANIMATION            FALSE
-    #define GWIN_NEED_RADIO                          FALSE
-    #define GWIN_NEED_LIST                           FALSE
-        #define GWIN_NEED_LIST_IMAGES                FALSE
-    #define GWIN_NEED_PROGRESSBAR                    FALSE
-        #define GWIN_PROGRESSBAR_AUTO                FALSE
-	#define GWIN_FLAT_STYLING                        FALSE
-#define GWIN_NEED_CONTAINERS                         FALSE
-    #define GWIN_NEED_CONTAINER                      FALSE
-    #define GWIN_NEED_FRAME                          FALSE
+//#define GFX_USE_GWIN                                 FALSE
+
+//#define GWIN_NEED_WINDOWMANAGER                      FALSE
+
+//#define GWIN_NEED_CONSOLE                            FALSE
+//    #define GWIN_CONSOLE_USE_HISTORY                 FALSE
+//        #define GWIN_CONSOLE_HISTORY_AVERAGING       FALSE
+//        #define GWIN_CONSOLE_HISTORY_ATCREATE        FALSE
+//    #define GWIN_CONSOLE_ESCSEQ                      FALSE
+//    #define GWIN_CONSOLE_USE_BASESTREAM              FALSE
+//    #define GWIN_CONSOLE_USE_FLOAT                   FALSE
+//#define GWIN_NEED_GRAPH                              FALSE
+
+//#define GWIN_NEED_WIDGET                             FALSE
+//    #define GWIN_NEED_LABEL                          FALSE
+//        #define GWIN_LABEL_ATTRIBUTE                 FALSE
+//    #define GWIN_NEED_BUTTON                         FALSE
+//        #define GWIN_BUTTON_LAZY_RELEASE             FALSE
+//    #define GWIN_NEED_SLIDER                         FALSE
+//    #define GWIN_NEED_CHECKBOX                       FALSE
+//    #define GWIN_NEED_IMAGE                          FALSE
+//        #define GWIN_NEED_IMAGE_ANIMATION            FALSE
+//    #define GWIN_NEED_RADIO                          FALSE
+//    #define GWIN_NEED_LIST                           FALSE
+//        #define GWIN_NEED_LIST_IMAGES                FALSE
+//    #define GWIN_NEED_PROGRESSBAR                    FALSE
+//        #define GWIN_PROGRESSBAR_AUTO                FALSE
+//    #define GWIN_FLAT_STYLING                        FALSE
+
+//#define GWIN_NEED_CONTAINERS                         FALSE
+//    #define GWIN_NEED_CONTAINER                      FALSE
+//    #define GWIN_NEED_FRAME                          FALSE
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GEVENT                                                                //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GEVENT                               FALSE
+//#define GFX_USE_GEVENT                               FALSE
 
-#define GEVENT_ASSERT_NO_RESOURCE                    FALSE
-#define GEVENT_MAXIMUM_SIZE                          32
-#define GEVENT_MAX_SOURCE_LISTENERS                  32
+//#define GEVENT_ASSERT_NO_RESOURCE                    FALSE
+//#define GEVENT_MAXIMUM_SIZE                          32
+//#define GEVENT_MAX_SOURCE_LISTENERS                  32
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GTIMER                                                                //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GTIMER                               FALSE
+//#define GFX_USE_GTIMER                               FALSE
 
-#define GTIMER_THREAD_PRIORITY                       HIGH_PRIORITY
-#define GTIMER_THREAD_WORKAREA_SIZE                  2048
+//#define GTIMER_THREAD_PRIORITY                       HIGH_PRIORITY
+//#define GTIMER_THREAD_WORKAREA_SIZE                  2048
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GQUEUE                                                                //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GQUEUE                               FALSE
+//#define GFX_USE_GQUEUE                               FALSE
 
-#define GQUEUE_NEED_ASYNC                            FALSE
-#define GQUEUE_NEED_GSYNC                            FALSE
-#define GQUEUE_NEED_FSYNC                            FALSE
-#define GQUEUE_NEED_BUFFERS                          FALSE
+//#define GQUEUE_NEED_ASYNC                            FALSE
+//#define GQUEUE_NEED_GSYNC                            FALSE
+//#define GQUEUE_NEED_FSYNC                            FALSE
+//#define GQUEUE_NEED_BUFFERS                          FALSE
 
 ///////////////////////////////////////////////////////////////////////////
 // GINPUT                                                                //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GINPUT                               FALSE
+//#define GFX_USE_GINPUT                               FALSE
 
-#define GINPUT_NEED_MOUSE                            FALSE
-#define GINPUT_NEED_KEYBOARD                         FALSE
-#define GINPUT_NEED_TOGGLE                           FALSE
-#define GINPUT_NEED_DIAL                             FALSE
+//#define GINPUT_NEED_MOUSE                            FALSE
+//#define GINPUT_NEED_KEYBOARD                         FALSE
+//#define GINPUT_NEED_TOGGLE                           FALSE
+//#define GINPUT_NEED_DIAL                             FALSE
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GFILE                                                                 //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GFILE                                FALSE
+//#define GFX_USE_GFILE                                FALSE
 
-#define GFILE_NEED_PRINTG                            FALSE
-#define GFILE_NEED_SCANG                             FALSE
-#define GFILE_NEED_STRINGS                           FALSE
-#define GFILE_NEED_STDIO                             FALSE
-    #define GFILE_ALLOW_FLOATS                       FALSE
-    #define GFILE_ALLOW_DEVICESPECIFIC               FALSE
-    #define GFILE_MAX_GFILES                         3
+//#define GFILE_NEED_PRINTG                            FALSE
+//#define GFILE_NEED_SCANG                             FALSE
+//#define GFILE_NEED_STRINGS                           FALSE
+//#define GFILE_NEED_STDIO                             FALSE
+//    #define GFILE_ALLOW_FLOATS                       FALSE
+//    #define GFILE_ALLOW_DEVICESPECIFIC               FALSE
+//    #define GFILE_MAX_GFILES                         3
 
-#define GFILE_NEED_MEMFS                             FALSE
-#define GFILE_NEED_ROMFS                             FALSE
-#define GFILE_NEED_RAMFS                             FALSE
-#define GFILE_NEED_FATFS                             FALSE
-#define GFILE_NEED_NATIVEFS                          FALSE
-#define GFILE_NEED_CHBIOSFS                          FALSE
+//#define GFILE_NEED_MEMFS                             FALSE
+//#define GFILE_NEED_ROMFS                             FALSE
+//#define GFILE_NEED_RAMFS                             FALSE
+//#define GFILE_NEED_FATFS                             FALSE
+//#define GFILE_NEED_NATIVEFS                          FALSE
+//#define GFILE_NEED_CHBIOSFS                          FALSE
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GADC                                                                  //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GADC                                 FALSE
+//#define GFX_USE_GADC                                 FALSE
 
-#define GADC_MAX_LOWSPEED_DEVICES                    4
+//#define GADC_MAX_LOWSPEED_DEVICES                    4
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GAUDIO                                                                //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GAUDIO                               FALSE
-    #define GAUDIO_NEED_PLAY                         FALSE
-    #define GAUDIO_NEED_RECORD                       FALSE
+//#define GFX_USE_GAUDIO                               FALSE
+//    #define GAUDIO_NEED_PLAY                         FALSE
+//    #define GAUDIO_NEED_RECORD                       FALSE
 
 
 ///////////////////////////////////////////////////////////////////////////
 // GMISC                                                                 //
 ///////////////////////////////////////////////////////////////////////////
-#define GFX_USE_GMISC                                FALSE
-
-#define GMISC_NEED_ARRAYOPS                          FALSE
-#define GMISC_NEED_FASTTRIG                          FALSE
-#define GMISC_NEED_FIXEDTRIG                         FALSE
-#define GMISC_NEED_INVSQRT                           FALSE
-    #define GMISC_INVSQRT_MIXED_ENDIAN               FALSE
-    #define GMISC_INVSQRT_REAL_SLOW                  FALSE
-
+//#define GFX_USE_GMISC                                FALSE
+
+//#define GMISC_NEED_ARRAYOPS                          FALSE
+//#define GMISC_NEED_FASTTRIG                          FALSE
+//#define GMISC_NEED_FIXEDTRIG                         FALSE
+//#define GMISC_NEED_INVSQRT                           FALSE
+//    #define GMISC_INVSQRT_MIXED_ENDIAN               FALSE
+//    #define GMISC_INVSQRT_REAL_SLOW                  FALSE
 
 #endif /* _GFXCONF_H */