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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*******************************************************************************
MPLAB Harmony Graphics Composer Generated Definitions Header
File Name:
gfx_hgc_definitions.h
Summary:
Build-time generated definitions header based on output by the MPLAB Harmony
Graphics Composer.
Description:
Build-time generated definitions header based on output by the MPLAB Harmony
Graphics Composer.
Created with MPLAB Harmony Version 1.06
*******************************************************************************/
// DOM-IGNORE-BEGIN
/*******************************************************************************
Copyright (c) 2013-2014 released Microchip Technology Inc. All rights reserved.
Microchip licenses to you the right to use, modify, copy and distribute
Software only when embedded on a Microchip microcontroller or digital signal
controller that is integrated into your product or third party product
(pursuant to the sublicense terms in the accompanying license agreement).
You should refer to the license agreement accompanying this Software for
additional information regarding your rights and obligations.
SOFTWARE AND DOCUMENTATION ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF
MERCHANTABILITY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
IN NO EVENT SHALL MICROCHIP OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER
CONTRACT, NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR
OTHER LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE OR
CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT OF
SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
*******************************************************************************/
// DOM-IGNORE-END
#ifndef _GFX_HGC_DEFINITIONS_H
#define _GFX_HGC_DEFINITIONS_H
#include "system_config.h"
#include "system_definitions.h"
// DOM-IGNORE-BEGIN
#ifdef __cplusplus // Provide C++ Compatibility
extern "C" {
#endif
// DOM-IGNORE-END
typedef enum
{
HGC_STATE_INIT = 0,
HGC_STATE_RUNNING
} HGC_STATES;
typedef enum
{
HGC_SCREEN_STATE_INIT = 0,
HGC_SCREEN_STATE_SETUP_SCREEN_Screen1,
HGC_SCREEN_STATE_PRE_DRAW_GOL_SCREEN_Screen1,
HGC_SCREEN_STATE_DRAW_GOL_SCREEN_Screen1,
HGC_SCREEN_STATE_POST_DRAW_GOL_SCREEN_Screen1,
HGC_SCREEN_STATE_PRE_DRAW_PRIMITIVE_SCREEN_Screen1,
HGC_SCREEN_STATE_DRAW_PRIMITIVE_SCREEN_Screen1,
HGC_SCREEN_STATE_POST_DRAW_PRIMITIVE_SCREEN_Screen1,
HGC_SCREEN_STATE_DISPLAY_SCREEN_Screen1,
} HGC_SCREEN_STATES;
/*** Screen IDs ***/
#define Screen1 0
// *****************************************************************************
/* MPLAB Harmony Graphics Composer Objects
Summary:
Structure holding the graphics object handles
Description:
This structure contains the object handles for all graphics objects
generated by the Harmony Graphics Composer
Remarks:
*/
typedef struct HGC_OBJECTS
{
HGC_SCREEN_STATES screenState; // current state of screen state machine
HGC_SCREEN_STATES prevRefreshState; // previous state of screen state machine
/*** GOL Objects References ***/
} HGC_OBJECTS;
extern HGC_OBJECTS hgcObj;
/******************************************************************************
Function:
void GFX_HGC_Setup ( void )
Summary:
This function sets up the GOL message callback and draw callbacks.
*/
void GFX_HGC_Setup ( void );
/******************************************************************************
Function:
HGC_SCREEN_STATES GFX_HGC_GetScreenState ( void )
Remarks:
This function returns the screen state
*/
HGC_SCREEN_STATES GFX_HGC_GetScreenState ( void );
/******************************************************************************
Function:
void GFX_HGC_SetScreenState ( HGC_SCREEN_STATES newState )
Remarks:
This function sets the screen state machine to a new state
*/
void GFX_HGC_SetScreenState ( HGC_SCREEN_STATES newState );
/******************************************************************************
Function:
void GFX_HGC_Tasks (SYS_MODULE_OBJ gfxObject);
Summary:
This function is called in SYS_Tasks. The intent wait until the GFX library
is initialized before supplying items to draw
*/
void GFX_HGC_Tasks (SYS_MODULE_OBJ gfxObject);
/******************************************************************************
Function:
void GFX_HGC_DrawScreenTask( void )
Remarks:
Task loop to drive the HGC generated screen state machine for HGC design
that has GFX_Primitives only
*/
void GFX_HGC_DrawScreenTask( void );
/******************************************************************************
Function:
bool GFX_HGC_DrawScreen_Primitives( uint8_t screenId )
Output:
Returns true if a screenId matches an existing screen identifier
Remarks:
HGC-specified GFX Primitives are drawn here, grouped by screen.
GFX Primitives are drawn after GFX GOL Objects to make sure GFX GOL Objects
do not cover GFX Primitives
*/
bool GFX_HGC_DrawScreen_Primitives(uint8_t screenId);
/******************************************************************************
Function:
void GFX_HGC_SetupScreen( uint8_t screenId )
Remarks:
Clears current screen and starts a fresh screen with its background color
*/
void GFX_HGC_SetupScreen(uint8_t screenId);
/******************************************************************************
Function:
bool GFX_HGC_ChangeScreen( uint8_t screenId )
Output:
Returns true if a screenId matches an existing screen identifier
Remarks:
Can be called to initiate GFX Library to draw a new screen
*/
bool GFX_HGC_ChangeScreen(uint8_t screenId);
/******************************************************************************
Function:
bool GFX_HGC_DrawItem(int itemId)
Output:
Returns true if a itemId matches an existing item identifier
Remarks:
Every item specified in every screen in HGC is listed in this function
*/
bool GFX_HGC_DrawItem(int itemId);
//DOM-IGNORE-BEGIN
#ifdef __cplusplus
}
#endif
//DOM-IGNORE-END
#endif // _GFX_HGC_DEFINITIONS_H
/*******************************************************************************
End of File
*/
|
