aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configure.txt
blob: 17540062d059dba2939fd0c485efc78d5fe14a00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
There are serval macros available to configure the behaviour of the GFX-Library.

HAL macros:

	#define HAL_USE_GFX					// enables the GDISP sub system. This is essentially needed to use the display
	#define GFX_USE_TOUCHPAD			// enables the TouchPad sub system. This is essentially needed to use the touchpad



GDISP macors:

	#define GDISP_USE_GPIO				// GDISP is connected to the MCU using GPIO interface, involves using lld_lcdWriteGPIO() and lld_lcdReadGPIO()
	#define GDISP_USE_FSMC				// GDISP is connected to the MCU using FSMC interface
	#define GDISP_USE_SPI				// GDISP is connected to the MCU using SPI interface

	#define GDISP_SCREEN_WIDTH			// defines width of panel in pixels. This is essentially needed to use the display
	#define GDISP_SCREEN_HEIGHT			// defines height of panel in pixels. This is essentailly needed to use the display

	#define GDISP_NEED_MULTITHREAD		// GDISP will be accessed across different threads -> thread safe mode 
	#define GDISP_NEED_CONTROL			// must be set to TRUE if controll access to the LCD controller is needed, eg for changing orientation or power mode
	#define GDISP_NEED_CLIP				// when clipping is needed
	#define GDISP_NEED_CIRCLE			// for circle drawing support (filled and frame)
	#define GDISP_NEED_ELLIPSE			// for ellipse drawing support (filled and frame)
	#define GDISP_NEED_ARC				// for arc drawing support (filled and frame)
	#define GDISP_NEED_TEXT				// for font rendering support
	#define GDISP_NEED_PIXELREAD		// to read a pixels color value back
	#define GDISP_NEED_SCROLL			// is scrolling is needed (pixel shift)
	#define GDISP_NEED_QUERY			// to make certain queries to the LCD controller

	#define GFX_USE_CONSOLE			// for the console abstraction


TouchPad macros:

	#define TOUCHPAD_NEED_MULTITHREAD	// TouchPad will be accessed across different threads -> thread safe mode
	
	#define TOUCHPAD_XY_INVERTED		// output of tpReadX() and tpReadY() swapped - needed if touchpad writes swapped to touchpad controller

	#define TOUCHPAD_STORE_CALIBRATION	// calibration values can be stored if set to true. Therefore tpCalibration() is not neccessary to call on each reset. involves using lld_tpWriteCalibration() and lld_tpReadCalibration()