blob: d30426dc8ac6cc206dfae2d86903eeb3954bb8b1 [file] [log] [blame]
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001/*
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
Doug Zongker830b3e32014-03-11 13:22:04 -070020#include <sys/types.h>
21
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070022#include <functional>
Doug Zongker28ce47c2011-10-28 10:33:05 -070023
Elliott Hughes07138192015-04-10 09:40:53 -070024//
25// Graphics.
26//
27
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070028struct GRSurface {
Doug Zongker39cf4172014-03-06 16:16:05 -080029 int width;
30 int height;
31 int row_bytes;
32 int pixel_bytes;
33 unsigned char* data;
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070034};
Doug Zongker39cf4172014-03-06 16:16:05 -080035
Damien Bargiacchi35fff612016-08-11 15:57:03 -070036struct GRFont {
37 GRSurface* texture;
38 int char_width;
39 int char_height;
40};
41
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070042int gr_init();
43void gr_exit();
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080044
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070045int gr_fb_width();
46int gr_fb_height();
Doug Zongker39cf4172014-03-06 16:16:05 -080047
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070048void gr_flip();
Dima Zavin4daf48a2011-08-30 11:59:20 -070049void gr_fb_blank(bool blank);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080050
Doug Zongker39cf4172014-03-06 16:16:05 -080051void gr_clear(); // clear entire surface to current color
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080052void gr_color(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
Doug Zongkerc560a672012-12-18 16:31:27 -080053void gr_fill(int x1, int y1, int x2, int y2);
Damien Bargiacchi35fff612016-08-11 15:57:03 -070054
Elliott Hughes0a5cb0c2015-04-15 10:58:56 -070055void gr_texticon(int x, int y, GRSurface* icon);
Damien Bargiacchi35fff612016-08-11 15:57:03 -070056
57const GRFont* gr_sys_font();
Damien Bargiacchid00f5eb2016-09-09 07:14:08 -070058int gr_init_font(const char* name, GRFont** dest);
Damien Bargiacchi35fff612016-08-11 15:57:03 -070059void gr_text(const GRFont* font, int x, int y, const char *s, bool bold);
60int gr_measure(const GRFont* font, const char *s);
61void gr_font_size(const GRFont* font, int *x, int *y);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080062
Elliott Hughes0a5cb0c2015-04-15 10:58:56 -070063void gr_blit(GRSurface* source, int sx, int sy, int w, int h, int dx, int dy);
64unsigned int gr_get_width(GRSurface* surface);
65unsigned int gr_get_height(GRSurface* surface);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080066
Elliott Hughes07138192015-04-10 09:40:53 -070067//
68// Input events.
69//
70
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080071struct input_event;
72
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070073// TODO: move these over to std::function.
Elliott Hughes07138192015-04-10 09:40:53 -070074typedef int (*ev_callback)(int fd, uint32_t epevents, void* data);
75typedef int (*ev_set_key_callback)(int code, int value, void* data);
Dima Zavinbc290632011-08-30 11:59:45 -070076
Elliott Hughes07138192015-04-10 09:40:53 -070077int ev_init(ev_callback input_cb, void* data);
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070078void ev_exit();
Elliott Hughes07138192015-04-10 09:40:53 -070079int ev_add_fd(int fd, ev_callback cb, void* data);
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070080void ev_iterate_available_keys(std::function<void(int)> f);
Elliott Hughes07138192015-04-10 09:40:53 -070081int ev_sync_key_state(ev_set_key_callback set_key_cb, void* data);
Dima Zavinbc290632011-08-30 11:59:45 -070082
Elliott Hughes07138192015-04-10 09:40:53 -070083// 'timeout' has the same semantics as poll(2).
84// 0 : don't block
85// < 0 : block forever
86// > 0 : block for 'timeout' milliseconds
Dima Zavinbc290632011-08-30 11:59:45 -070087int ev_wait(int timeout);
88
Elliott Hughes07cfb8f2015-04-10 13:12:05 -070089int ev_get_input(int fd, uint32_t epevents, input_event* ev);
90void ev_dispatch();
91int ev_get_epollfd();
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080092
Elliott Hughes07138192015-04-10 09:40:53 -070093//
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080094// Resources
Elliott Hughes07138192015-04-10 09:40:53 -070095//
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080096
Tianjie Xu2430e292016-04-19 15:02:41 -070097bool matches_locale(const char* prefix, const char* locale);
98
Doug Zongkera418aa72014-03-17 12:10:02 -070099// res_create_*_surface() functions return 0 if no error, else
100// negative.
101//
102// A "display" surface is one that is intended to be drawn to the
103// screen with gr_blit(). An "alpha" surface is a grayscale image
104// interpreted as an alpha mask used to render text in the current
105// color (with gr_text() or gr_texticon()).
106//
107// All these functions load PNG images from "/res/images/${name}.png".
108
109// Load a single display surface from a PNG image.
Elliott Hughes0a5cb0c2015-04-15 10:58:56 -0700110int res_create_display_surface(const char* name, GRSurface** pSurface);
Doug Zongkera418aa72014-03-17 12:10:02 -0700111
112// Load an array of display surfaces from a single PNG image. The PNG
113// should have a 'Frames' text chunk whose value is the number of
114// frames this image represents. The pixel data itself is interlaced
115// by row.
Tao Baob723f4f2015-12-11 15:18:51 -0800116int res_create_multi_display_surface(const char* name, int* frames,
117 int* fps, GRSurface*** pSurface);
Doug Zongkera418aa72014-03-17 12:10:02 -0700118
119// Load a single alpha surface from a grayscale PNG image.
Elliott Hughes0a5cb0c2015-04-15 10:58:56 -0700120int res_create_alpha_surface(const char* name, GRSurface** pSurface);
Doug Zongkera418aa72014-03-17 12:10:02 -0700121
122// Load part of a grayscale PNG image that is the first match for the
123// given locale. The image is expected to be a composite of multiple
124// translations of the same text, with special added rows that encode
125// the subimages' size and intended locale in the pixel data. See
126// development/tools/recovery_l10n for an app that will generate these
127// specialized images from Android resources.
128int res_create_localized_alpha_surface(const char* name, const char* locale,
Elliott Hughes0a5cb0c2015-04-15 10:58:56 -0700129 GRSurface** pSurface);
Doug Zongkera418aa72014-03-17 12:10:02 -0700130
131// Free a surface allocated by any of the res_create_*_surface()
132// functions.
Elliott Hughes0a5cb0c2015-04-15 10:58:56 -0700133void res_free_surface(GRSurface* surface);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800134
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800135#endif