aboutsummaryrefslogtreecommitdiffstats
path: root/src/gfx_options.h
blob: afb8f35abffde2ecae05f88005431d62c154d70d (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
 * This file is subject to the terms of the GFX License. If a copy of
 * the license was not distributed with this file, you can obtain one at:
 *
 *              http://ugfx.io/license.html
 */

/**
 * @file    gfx_options.h
 * @brief   GFX system options.
 *
 * @addtogroup GFX
 * @{
 */

/**
 * @name    GFX sub-systems that can be turned on
 * @{
 */
	/**
	 * @brief   GFX Driver API
	 * @details	Defaults to GFXON
	 * @note	Not much useful can be done without a driver
	 */
	#ifndef GFX_USE_GDRIVER
		#define GFX_USE_GDRIVER	GFXON
	#endif
	/**
	 * @brief   GFX Graphics Display Basic API
	 * @details	Defaults to GFXOFF
	 * @note	Also add the specific hardware driver to your makefile.
	 * 			Eg.  include $(GFXLIB)/drivers/gdisp/Nokia6610/driver.mk
	 */
	#ifndef GFX_USE_GDISP
		#define GFX_USE_GDISP	GFXOFF
	#endif
	/**
	 * @brief   GFX Graphics Windowing API
	 * @details	Defaults to GFXOFF
	 * @details	Extends the GDISP API to add the concept of graphic windows.
	 * @note	Also supports high-level "window" objects such as console windows,
	 * 			buttons, graphing etc
	 */
	#ifndef GFX_USE_GWIN
		#define GFX_USE_GWIN	GFXOFF
	#endif
	/**
	 * @brief   GFX Event API
	 * @details	Defaults to GFXOFF
	 * @details	Defines the concept of a "Source" that can send "Events" to "Listeners".
	 */
	#ifndef GFX_USE_GEVENT
		#define GFX_USE_GEVENT	GFXOFF
	#endif
	/**
	 * @brief   GFX Timer API
	 * @details	Defaults to GFXOFF
	 * @details	Provides thread context timers - both one-shot and periodic.
	 */
	#ifndef GFX_USE_GTIMER
		#define GFX_USE_GTIMER	GFXOFF
	#endif
	/**
	 * @brief   GFX Queue API
	 * @details	Defaults to GFXOFF
	 * @details	Provides queue management.
	 */
	#ifndef GFX_USE_GQUEUE
		#define GFX_USE_GQUEUE	GFXOFF
	#endif
	/**
	 * @brief   GFX Input Device API
	 * @details	Defaults to GFXOFF
	 * @note	Also add the specific hardware drivers to your makefile.
	 * 			Eg.
	 * 				include $(GFXLIB)/drivers/ginput/toggle/Pal/driver.mk
	 * 			and...
	 * 				include $(GFXLIB)/drivers/ginput/touch/MCU/driver.mk
	 */
	#ifndef GFX_USE_GINPUT
		#define GFX_USE_GINPUT	GFXOFF
	#endif
	/**
	 * @brief   GFX Generic Periodic ADC API
	 * @details	Defaults to GFXOFF
	 */
	#ifndef GFX_USE_GADC
		#define GFX_USE_GADC	GFXOFF
	#endif
	/**
	 * @brief   GFX Audio API
	 * @details	Defaults to GFXOFF
	 * @note	Also add the specific hardware drivers to your makefile.
	 * 			Eg.
	 * 				include $(GFXLIB)/drivers/gaudio/GADC/driver.mk
	 */
	#ifndef GFX_USE_GAUDIO
		#define GFX_USE_GAUDIO	GFXOFF
	#endif
	/**
	 * @brief   GFX Miscellaneous Routines API
	 * @details	Defaults to GFXOFF
	 * @note	Turning this on without turning on any GMISC_NEED_xxx macros will result
	 * 			in no extra code being compiled in. GMISC is made up from the sum of its
	 * 			parts.
	 */
	#ifndef GFX_USE_GMISC
		#define GFX_USE_GMISC	GFXOFF
	#endif
	/**
	 * @brief   GFX File API
	 * @details	Defaults to GFXOFF
	 */
	#ifndef GFX_USE_GFILE
		#define GFX_USE_GFILE	GFXOFF
	#endif
	/**
	 * @brief   GFX Translation Support API
	 * @details	Defaults to GFXOFF
	 */
	#ifndef GFX_USE_GTRANS
		#define GFX_USE_GTRANS	GFXOFF
	#endif
/** @} */

/**
 * @name    GFX compatibility options
 * @{
 */
	/**
	 * @brief   Include the uGFX V2.x Old Colors
	 * @details	Defaults to GFXON
	 * @pre		Requires GFX_COMPAT_V2 to be GFXON
	 * @note	The old color definitions (particularly Red, Green & Blue) can
	 *			cause symbol conflicts with many platforms eg Win32, STM32 HAL etc.
	 *			Although officially these symbols are part of the V2.x API, this
	 *			option allows them to be turned off even when the rest of the V2.x
	 *			API is turned on.
	 */
	#ifndef GFX_COMPAT_OLDCOLORS
		#define GFX_COMPAT_OLDCOLORS		GFXON
	#endif
/** @} */

/** @} */