Configuration

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.

GOS

Option	Description
GFX_USE_OS_RAW32	Use the bare metal port without any underlying OS. See BareMetal
GFX_USE_OS_CHIBIOS	Use ChibiOS/RT as the underlying system. See ChibiOS/RT.
GFX_USE_OS_FREERTOS	Use FreeRTOS as the underlying system. See FreeRTOS.
GFX_FREERTOS_USE_TRACE	Enable support for the FreeRTOS+Trace feature. See Trace.
GFX_USE_OS_WIN32	Use Windows as the underlying system. See Windows.
GFX_USE_OS_LINUX	Use Linux as the underlying system. See Linux.
GFX_USE_OS_OSX	Use Mac OS X as the underlying system. See Mac_OS_X.

GDISP

Option	Description
GFX_USE_GDISP	Enable or disable the entire GDISP module. See GDISP.
GDISP_NEED_AUTOFLUSH	Flush drawing operations automatically. See Flushing.
GDISP_NEED_TIMERFLUSH	Flush drawing operations automatically using a timer. See Flushing.
GDISP_NEED_VALIDATION	Clip all drawing operations to the screen limits and validate color values. See Validation.
	GDISP_NEED_CLIP	Add area clipping feature. See Clipping.
GDISP_NEED_CIRCLE	Include circle drawing functions. See Circle.
GDISP_NEED_ELLIPSE	Include ellipse drawing functions. See Ellipse.
GDISP_NEED_ARC	Include arc drawing functions. See Arc.
GDISP_NEED_CONVEX_POLYGON	Include convex polygon drawing functions. See Polygon.

GWIN

Option	Description
GFX_USE_GWIN	Enable or disable the entire GWIN module. See GWIN.
GWIN_NEED_WINDOWMANAGER	Enable or disable the window manager. See ToDo.
GWIN_REDRAW_IMMEDIATE	ToDo. See ToDo.
GWIN_REDRAW_SINGLEOP	ToDo. See ToDo.
GWIN_NEED_CONSOLE	Include the console window features. See Console.
GWIN_CONSOLE_USE_HISTORY	Enable or disable the console history. See History.
GWIN_CONSOLE_HISTORY_AVERAGING	Create an average history buffer. See History.
GWIN_CONSOLE_HISTORY_ATCREATE	Create a history buffer at window creation time. See History.
GWIN_CONSOLE_ESQSEQ	Include escape sequence features. See Escape sequences.
GWIN_CONSOLE_USE_BASESTREAM	Include support for ChibiOS/RT base streams. See ToDo.
GWIN_CONSOLE_USE_FLOAT	Include support for floating point numbers. See Float.
GWIN_NEED_GRAPH	Include the graph window features. See Graph.
GWIN_NEED_WIDGET	Enable or disable the widget system. See Widgets.
GWIN_FLAT_STYLING	ToDo. See ToDo.
GWIN_NEED_LABEL	Enable or disable the label widget. See Label.
GWIN_NEED_LABEL_ATTRIBUTE	Include the label attribute feature. See Attribute.
GWIN_NEED_BUTTON	Enable or disable the push button widget. See PushButton.
GWIN_NEED_BUTTON_LAZY_RELEASE	Enabel or disable the lazy release feature. See Cancel feature.
GWIN_NEED_SLIDER	Enable or disable the slider widget. See Slider.
GWIN_NEED_CHECKBOX	Enable or disable the check box widget. See CheckBox.
GWIN_NEED_IMAGE	Enable or disable the image box widget. See ImageBox.
GWIN_NEED_IMAGE_ANIMATION	Include the image box animated images feature. See Animated Images.
GWIN_NEED_RADIO	Enable or disable the radio button widget. See RadioButton.
GWIN_NEED_LIST	Enable or disable the list widget. See List.
GWIN_NEED_LIST_IMAGES	Include the list widget images feature. See Images.
GWIN_NEED_PROGRESSBAR	Enable or disable the progress bar widget. See Progressbar.
GWIN_NEED_PROGRESSBAR_AUTO	Include the automatic progress bar feature. See Automatic.
GWIN_NEED_CONTAINERS	Enable or disable the containers system. See Containers.
GWIN_NEED_CONTAINER	Enable or disable the basic container. See Container.
GWIN_NEED_FRAME	Enable or disable the frame container. See Frame.

GEVENT

Option	Description
GFX_USE_GTIMER	Enable or disable the entire GTIMER module. See GTIMER.
GTIMER_THREAD_PRIORITY	The GTIMER thread priority level.<br/See Priority.
GTIMER_THREAD_WORKING_SIZE	The GTIMER thread stack size. See Stack size.

GQUEUE

Option	Description
GFX_USE_GQUEUE	Enable or disable the entire GQUEUE module. See GQUEUE.
GQUEUE_NEED_ASYNC	Enable or disable the asynchronous queue functions. See Asynchronous.
GQUEUE_NEED_GSYNC	Enable or disable the GET synchronous queue functions. See Asynchronous.
GQUEUE_NEED_FSYNC	Enable or disable the fully synchronous queue functions. See Asynchronous.
GQUEUE_NEED_BUFFERS	Enable or disable the buffers functions. See Buffers.

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. See GFILE.
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	' prefix in order to ensure the file is opened with the specified file system. See Multiple file systems.
GFILE_MAX_GFILES	Specify the maximum amount of files that can be opened at a time. See ToDo.
GFILE_NEED_NOAUTOMOUNT	Enable or disable automatic file system mounting feature. See Mounting.
GFILE_NEED_NOAUTOSYNC	Enable or disable automatic file system synchronization feature. See Syncronization.
GFILE_NEED_FATFS	Enable or disable FatFS support. See FATFS.
GFILE_NEED_ROMFS	Enable or disable ROMFS support. See ROMFS.
GFILE_NEED_RAMFS	Enable or disable RAMFS support. See RAMFS.
GFILE_NEED_MEMFS	Enable or disable MEMFS support. See MEMFS.
GFILE_NEED_NATIVEFS	Enable or disable NATIVEFS support. See NATIVEFS.
GFILE_NEED_CHIBIOSFS	Enable or disable CHIBIOSFS support. See CHIBIOSFS.

GAUDIO

Option	Description
GFX_USE_GAUDIO	Enable or disable the entire GAUDIO module. See GAUDIO.
GAUDIO_NEED_PLAY	Enable or disable the play-back system (audio output). See PlayBack.
GAUDIO_NEED_RECORD	Enable or disable the record system (audio input). See Record.

GADC

Option	Description
GFX_USE_GADC	Enable or disable the entire GADC module. See GADC.
GADC_MAX_LOWSPEED_DEVICES	Specify the maximum amount of low speed GADC devices. See GADC.

GMISC

Option	Description
GFX_USE_GMISC	Enable or disable the entire GMISC module. See GMISC.
GMISC_NEED_ARRAOPS	ToDo. See ToDo.
GMISC_NEED_FASTTRIG	ToDo. See ToDo.
GMISC_NEED_FIXEDTRIG	ToDo. See ToDo.
GMISC_NEED_INVSQRT	ToDo. See ToDo.
GMISC_INVSQRT_MIXED_ENDIAN	ToDo. See ToDo.
GMISC_INVSQRT_REAL_SLOW	ToDo. See ToDo.