Difference between revisions of "Configuration"

From uGFX Wiki
Jump to: navigation, search
(→‎GWIN)
(→‎GWIN)
Line 49: Line 49:
 
  |-
 
  |-
 
  |GWIN_NEED_GRAPH
 
  |GWIN_NEED_GRAPH
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Include the graph window features.<br/>See [[Graph|Graph]].
 
  |-style="height:25px"
 
  |-style="height:25px"
 
  |
 
  |
 
  |-
 
  |-
 
  |GWIN_NEED_WIDGET
 
  |GWIN_NEED_WIDGET
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the widget system.<br/>See [[Widgets|Widgets]].
 
  |-
 
  |-
 
  |GWIN_FLAT_STYLING
 
  |GWIN_FLAT_STYLING
Line 60: Line 60:
 
  |-
 
  |-
 
  |GWIN_NEED_LABEL
 
  |GWIN_NEED_LABEL
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the label widget.<br/>See [[Label|Label]].
 
  |-
 
  |-
 
  |GWIN_NEED_LABEL_ATTRIBUTE
 
  |GWIN_NEED_LABEL_ATTRIBUTE
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Include the label attribute feature.<br/>See [[Label#Attribute|Attribute]].
 
  |-
 
  |-
 
  |GWIN_NEED_BUTTON
 
  |GWIN_NEED_BUTTON
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the push button widget.<br/>See [[PushButton|PushButton]].
 
  |-
 
  |-
 
  |GWIN_NEED_BUTTON_LAZY_RELEASE
 
  |GWIN_NEED_BUTTON_LAZY_RELEASE
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enabel or disable the lazy release feature.<br/>See [[PushButton#Cancel_feature|Cancel feature]].
 
  |-
 
  |-
 
  |GWIN_NEED_SLIDER
 
  |GWIN_NEED_SLIDER
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the slider widget.<br/>See [[Slider|Slider]].
 
  |-
 
  |-
 
  |GWIN_NEED_CHECKBOX
 
  |GWIN_NEED_CHECKBOX
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the check box widget.<br/>See [[CheckBox|CheckBox]].
 
  |-
 
  |-
 
  |GWIN_NEED_IMAGE
 
  |GWIN_NEED_IMAGE
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the image box widget.<br/>See [[ImageBox|ImageBox]].
 
  |-
 
  |-
 
  |GWIN_NEED_IMAGE_ANIMATION
 
  |GWIN_NEED_IMAGE_ANIMATION
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Include the image box animated images feature.<br/>See [[ImageBox#Animated_Images|Animated Images]].
 
  |-
 
  |-
 
  |GWIN_NEED_RADIO
 
  |GWIN_NEED_RADIO
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the radio button widget.<br/>See [[RadioButton|RadioButton]].
 
  |-
 
  |-
 
  |GWIN_NEED_LIST
 
  |GWIN_NEED_LIST
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the list widget.<br/>See [[List|List]].
 
  |-
 
  |-
 
  |GWIN_NEED_LIST_IMAGES
 
  |GWIN_NEED_LIST_IMAGES
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Include the list widget images feature.<br/>See [[List#Images|Images]].
 
  |-
 
  |-
 
  |GWIN_NEED_PROGRESSBAR
 
  |GWIN_NEED_PROGRESSBAR
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the progress bar widget.<br/>See [[ProgressBar|ProgressBar]].
 
  |-
 
  |-
 
  |GWIN_NEED_PROGRESSBAR_AUTO
 
  |GWIN_NEED_PROGRESSBAR_AUTO
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Include the automatic progress bar feature.<br/>See [[ProgressBar#Automatic|Automatic]].
−
|-
+
−
|GWIN_FLAT_STYLING
+
−
|ToDo.<br/>See [[ToDo|ToDo]].
+
−
|-style="height:25px"
+
−
|
+
 
  |-
 
  |-
 
  |GWIN_NEED_CONTAINERS
 
  |GWIN_NEED_CONTAINERS
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the containers system.<br/>See [[Containers|Containers]].
 
  |-
 
  |-
 
  |GWIN_NEED_CONTAINER
 
  |GWIN_NEED_CONTAINER
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the basic container.<br/>See [[Container|Container]].
 
  |-
 
  |-
 
  |GWIN_NEED_FRAME
 
  |GWIN_NEED_FRAME
−
  |ToDo.<br/>See [[ToDo|ToDo]].
+
  |Enable or disable the frame container.<br/>See [[Frame|Frame]].
 
  |}
 
  |}
  

Revision as of 23:42, 1 July 2014

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.

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.
Retrieved from "https://wiki.ugfx.io/index.php?title=Configuration&oldid=310"