Configuration

From uGFX Wiki
Revision as of 22:50, 1 July 2014 by Tectu (Talk | contribs)

Jump to: navigation, search

This page describes each and every configuration option for the µGFX library. More detailed descriptions and further readings can be found in the documentation pages of the corresponding module.

Template

A template of the gfxconf.h file can be found in the top-level directory of the µGFX folder. It is called gfxconf.example.h. You can copy this file to your project directory and rename it to gfxconf.h.

GINPUT

Option Description
GFX_USE_GINPUT Enable or disable the entire GINPUT module.
See GINPUT.
GINPUT_NEED_MOUSE Enable or disable support for a pointing device such as a touchscreen.
See Touchscreen.
GINPUT_NEED_KEYBOARD Not implemented yet.
GINPUT_NEED_TOGGLE Enable or disable support for digital inputs.
See digital inputs.
GINPUT_NEED_DIAL Enable or disable support for analog inputs.
See analog inputs.
GINPUT_MOUSE_CALIBRATE_EXTREMES If this is set to TRUE, the calibration points are displayed at the very corner of the display. This gives an overall more accurate result but they are less intuitive.
See calibration.
GINPUT_MOUSE_MAX_CALIBRATION_ERROR This macro is part of the config file of the driver in your board directory and takes a pixel value. It defines how big the pixel offset of the test point can be before the calibration process is repeated automatically.
See calibration.

GFILE

Option Description
GFX_USE_GFILE Enable or disable the entire GFILE module.
GFILE_NEED_PRINTG Enable or disable print functions support.
See String manipulation & printing.
GFILE_NEED_SCANG Enable or disable scan functions support.
See String manipulation & printing.
GFILE_NEED_STRINGS Enable or disable string manipulation functions support.
See String manipulation & printing.
GFILE_NEED_STDIO Enable or disable STDIO emulation.
See STDIO emulation.
GFILE_ALLOW_FLOATS Enable or disable float support.
See STDIO emulation.
GFILE_ALLOW_DEVICESPECIFIC ToDo
See GFILE#ToDo.
GFILE_MAX_GFILES Specify the maximum amount of files that can be opened at a time.
See GFILE#ToDo.
GFILE_NEED_NOAUTOMOUNT Enable or disable automatic file system mounting feature.
See GFILE#Mounting.
GFILE_NEED_NOAUTOSYNC Enable or disable automatic file system synchronization feature.
See GFILE#Syncronization.
GFILE_NEED_FATFS Enable or disable FatFS support.
See FATFS.


//#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_NOAUTOMOUNT FALSE //#define GFILE_NEED_NOAUTOSYNC 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


To Be continued...