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 
20 #include <sys/types.h>
21 
22 #include <functional>
23 
24 //
25 // Graphics.
26 //
27 
28 struct GRSurface {
29     int width;
30     int height;
31     int row_bytes;
32     int pixel_bytes;
33     unsigned char* data;
34 };
35 
36 int gr_init();
37 void gr_exit();
38 
39 int gr_fb_width();
40 int gr_fb_height();
41 
42 void gr_flip();
43 void gr_fb_blank(bool blank);
44 
45 void gr_clear();  // clear entire surface to current color
46 void gr_color(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
47 void gr_fill(int x1, int y1, int x2, int y2);
48 void gr_text(int x, int y, const char *s, bool bold);
49 void gr_texticon(int x, int y, GRSurface* icon);
50 int gr_measure(const char *s);
51 void gr_font_size(int *x, int *y);
52 
53 void gr_blit(GRSurface* source, int sx, int sy, int w, int h, int dx, int dy);
54 unsigned int gr_get_width(GRSurface* surface);
55 unsigned int gr_get_height(GRSurface* surface);
56 
57 //
58 // Input events.
59 //
60 
61 struct input_event;
62 
63 // TODO: move these over to std::function.
64 typedef int (*ev_callback)(int fd, uint32_t epevents, void* data);
65 typedef int (*ev_set_key_callback)(int code, int value, void* data);
66 
67 int ev_init(ev_callback input_cb, void* data);
68 void ev_exit();
69 int ev_add_fd(int fd, ev_callback cb, void* data);
70 void ev_iterate_available_keys(std::function<void(int)> f);
71 int ev_sync_key_state(ev_set_key_callback set_key_cb, void* data);
72 
73 // 'timeout' has the same semantics as poll(2).
74 //    0 : don't block
75 //  < 0 : block forever
76 //  > 0 : block for 'timeout' milliseconds
77 int ev_wait(int timeout);
78 
79 int ev_get_input(int fd, uint32_t epevents, input_event* ev);
80 void ev_dispatch();
81 int ev_get_epollfd();
82 
83 //
84 // Resources
85 //
86 
87 bool matches_locale(const char* prefix, const char* locale);
88 
89 // res_create_*_surface() functions return 0 if no error, else
90 // negative.
91 //
92 // A "display" surface is one that is intended to be drawn to the
93 // screen with gr_blit().  An "alpha" surface is a grayscale image
94 // interpreted as an alpha mask used to render text in the current
95 // color (with gr_text() or gr_texticon()).
96 //
97 // All these functions load PNG images from "/res/images/${name}.png".
98 
99 // Load a single display surface from a PNG image.
100 int res_create_display_surface(const char* name, GRSurface** pSurface);
101 
102 // Load an array of display surfaces from a single PNG image.  The PNG
103 // should have a 'Frames' text chunk whose value is the number of
104 // frames this image represents.  The pixel data itself is interlaced
105 // by row.
106 int res_create_multi_display_surface(const char* name, int* frames,
107                                      int* fps, GRSurface*** pSurface);
108 
109 // Load a single alpha surface from a grayscale PNG image.
110 int res_create_alpha_surface(const char* name, GRSurface** pSurface);
111 
112 // Load part of a grayscale PNG image that is the first match for the
113 // given locale.  The image is expected to be a composite of multiple
114 // translations of the same text, with special added rows that encode
115 // the subimages' size and intended locale in the pixel data.  See
116 // development/tools/recovery_l10n for an app that will generate these
117 // specialized images from Android resources.
118 int res_create_localized_alpha_surface(const char* name, const char* locale,
119                                        GRSurface** pSurface);
120 
121 // Free a surface allocated by any of the res_create_*_surface()
122 // functions.
123 void res_free_surface(GRSurface* surface);
124 
125 #endif
126