xref: /OK3568_Linux_fs/external/recovery/minui/minui.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /*
2  * Copyright (C) 2007 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef _MINUI_H_
18 #define _MINUI_H_
19 #include <inttypes.h>
20 #include <sys/types.h>
21 
22 #include <stdbool.h>
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 typedef struct {
29     int width;
30     int height;
31     int row_bytes;
32     int pixel_bytes;
33     unsigned char* data;
34 } GRSurface;
35 
36 typedef GRSurface* gr_surface;
37 
38 typedef enum GRRotation_e {
39     ROTATION_NONE = 0,
40     ROTATION_RIGHT = 1,
41     ROTATION_DOWN = 2,
42     ROTATION_LEFT = 3,
43 } GRRotation;
44 
45 int gr_init(void);
46 void gr_exit(void);
47 
48 int gr_fb_width(void);
49 int gr_fb_height(void);
50 
51 void gr_flip(void);
52 void gr_fb_blank(bool blank);
53 
54 void gr_clear();  // clear entire surface to current color
55 void gr_color(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
56 void gr_fill(int x1, int y1, int x2, int y2);
57 void gr_text(int x, int y, const char *s);
58 void gr_texticon(int x, int y, gr_surface icon);
59 int gr_measure(const char *s);
60 void gr_font_size(int *x, int *y);
61 
62 void gr_blit(gr_surface source, int sx, int sy, int w, int h, int dx, int dy);
63 unsigned int gr_get_width(gr_surface surface);
64 unsigned int gr_get_height(gr_surface surface);
65 // Set rotation, flips gr_fb_width/height if 90 degree rotation difference
66 void gr_rotate(GRRotation rotation);
67 
68 
69 // input event structure, include <linux/input.h> for the definition.
70 // see http://www.mjmwired.net/kernel/Documentation/input/ for info.
71 struct input_event;
72 
73 typedef int (*ev_callback)(int fd, uint32_t epevents, void *data);
74 typedef int (*ev_set_key_callback)(int code, int value, void *data);
75 
76 int ev_init(ev_callback input_cb, void *data);
77 void ev_exit(void);
78 int ev_add_fd(int fd, ev_callback cb, void *data);
79 int ev_sync_key_state(ev_set_key_callback set_key_cb, void *data);
80 
81 /* timeout has the same semantics as for poll
82  *    0 : don't block
83  *  < 0 : block forever
84  *  > 0 : block for 'timeout' milliseconds
85  */
86 int ev_wait(int timeout);
87 
88 int ev_get_input(int fd, uint32_t epevents, struct input_event *ev);
89 void ev_dispatch(void);
90 int ev_get_epollfd(void);
91 
92 // Resources
93 
94 // res_create_*_surface() functions return 0 if no error, else
95 // negative.
96 //
97 // A "display" surface is one that is intended to be drawn to the
98 // screen with gr_blit().  An "alpha" surface is a grayscale image
99 // interpreted as an alpha mask used to render text in the current
100 // color (with gr_text() or gr_texticon()).
101 //
102 // All these functions load PNG images from "/res/images/${name}.png".
103 
104 // Load a single display surface from a PNG image.
105 int res_create_display_surface(const char* name, gr_surface* pSurface);
106 
107 // Load an array of display surfaces from a single PNG image.  The PNG
108 // should have a 'Frames' text chunk whose value is the number of
109 // frames this image represents.  The pixel data itself is interlaced
110 // by row.
111 int res_create_multi_display_surface(const char* name,
112                                      int* frames, gr_surface** pSurface);
113 
114 // Load a single alpha surface from a grayscale PNG image.
115 int res_create_alpha_surface(const char* name, gr_surface* pSurface);
116 
117 // Load part of a grayscale PNG image that is the first match for the
118 // given locale.  The image is expected to be a composite of multiple
119 // translations of the same text, with special added rows that encode
120 // the subimages' size and intended locale in the pixel data.  See
121 // development/tools/recovery_l10n for an app that will generate these
122 // specialized images from Android resources.
123 int res_create_localized_alpha_surface(const char* name, const char* locale,
124                                        gr_surface* pSurface);
125 
126 // Free a surface allocated by any of the res_create_*_surface()
127 // functions.
128 void res_free_surface(gr_surface surface);
129 
130 void gr_set_rotate(int val);
131 #ifdef __cplusplus
132 }
133 #endif
134 
135 #endif
136